Bug 32030: Add users to licenses - REST API Spec
[koha.git] / api / v1 / swagger / definitions / erm_license.yaml
1 ---
2 type: object
3 properties:
4   license_id:
5     type: integer
6     description: internally assigned license 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 license
15     type: string
16   description:
17     description: description of the license
18     type:
19       - string
20       - "null"
21   type:
22     description: description of the license
23     type: string
24   status:
25     description: status of the license
26     type: string
27   started_on:
28     type:
29       - string
30       - "null"
31     format: date
32     description: Start of the license
33   ended_on:
34     type:
35       - string
36       - "null"
37     format: date
38     description: End of the license
39   user_roles:
40     type: array
41     description: role for users
42     items:
43       $ref: erm_user_role.yaml
44   documents:
45     type: array
46     description: documents
47     items:
48       $ref: erm_document.yaml
49   vendor:
50     description: Information about the vendor
51     type:
52       - object
53       - "null"
54
55 additionalProperties: false
56 required:
57   - license_id
58   - name
59   - status
60   - type