koha-dev.rot13.org Git - srvgit/blob - api/v1/swagger/definitions/erm_agreement.yaml

   1 ---
   2 type: object
   3 properties:
   4   agreement_id:
   5     type: integer
   6     description: internally assigned agreement identifier
   7     readOnly: true
   8   vendor_id:
   9     description: foreign key to aqbooksellers
  10     type:
  11       - integer
  12       - "null"
  13   name:
  14     description: name of the agreement
  15     type: string
  16   description:
  17     description: description of the agreement
  18     type:
  19       - string
  20       - "null"
  21   status:
  22     description: current status of the agreement
  23     type: string
  24   closure_reason:
  25     description: reason of the closure
  26     type:
  27       - string
  28       - "null"
  29   is_perpetual:
  30     description: is the agreement perpetual
  31     type: boolean
  32   renewal_priority:
  33     description: priority of the renewal
  34     type:
  35       - string
  36       - "null"
  37   license_info:
  38     description: info about the license
  39     type:
  40       - string
  41       - "null"
  42   periods:
  43     type: array
  44     description: periods defined for this agreement
  45     items:
  46       $ref: erm_agreement_period.yaml
  47   user_roles:
  48     type: array
  49     description: role for users
  50     items:
  51       $ref: erm_agreement_user_role.yaml
  52   agreement_relationships:
  53     type: array
  54     description: agreement relationships
  55     items:
  56       $ref: erm_agreement_relationship.yaml
  57   agreement_licenses:
  58     type: array
  59     description: agreement licenses
  60     items:
  61       $ref: erm_agreement_license.yaml
  62   documents:
  63     type: array
  64     description: documents
  65     items:
  66       $ref: erm_agreement_document.yaml
  67
  68 additionalProperties: false
  69 required:
  70   - agreement_id
  71   - name
  72   - status
  73   - is_perpetual