Bug 32030: Add users to licenses - REST API Spec

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

diff --git a/api/v1/swagger/definitions/erm_agreement.yaml b/api/v1/swagger/definitions/erm_agreement.yaml
index f2c3f49..e8fc871 100644 (file)
--- a/api/v1/swagger/definitions/erm_agreement.yaml
+++ b/api/v1/swagger/definitions/erm_agreement.yaml
@@ -48,7 +48,7 @@ properties:
     type: array
     description: role for users
     items:
-      $ref: erm_agreement_user_role.yaml
+      $ref: erm_user_role.yaml
   agreement_relationships:
     type: array
     description: agreement relationships

diff --git a/api/v1/swagger/definitions/erm_agreement_user_role.yaml b/api/v1/swagger/definitions/erm_agreement_user_role.yaml
deleted file mode 100644 (file)
index 68c3cb3..0000000
--- a/api/v1/swagger/definitions/erm_agreement_user_role.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
----
-type: object
-properties:
-  agreement_id:
-    type: integer
-    description: Internal agreement identifier
-  user_id:
-    type: integer
-    description: Internal patron identifier
-  role:
-    description: role of the user
-    type:
-      - string
-  patron:
-    type:
-      - object
-      - "null"
-additionalProperties: false
-required:
-  - user_id
-  - role

diff --git a/api/v1/swagger/definitions/erm_license.yaml b/api/v1/swagger/definitions/erm_license.yaml
index f17f92d..5a2d43c 100644 (file)
--- a/api/v1/swagger/definitions/erm_license.yaml
+++ b/api/v1/swagger/definitions/erm_license.yaml
@@ -36,6 +36,11 @@ properties:
       - "null"
     format: date
     description: End of the license
+  user_roles:
+    type: array
+    description: role for users
+    items:
+      $ref: erm_user_role.yaml
   documents:
     type: array
     description: documents

diff --git a/api/v1/swagger/definitions/erm_user_role.yaml b/api/v1/swagger/definitions/erm_user_role.yaml
new file mode 100644 (file)
index 0000000..7256542
--- /dev/null
+++ b/api/v1/swagger/definitions/erm_user_role.yaml
@@ -0,0 +1,28 @@
+---
+type: object
+properties:
+  agreement_id:
+    type:
+      - integer
+      - "null"
+    description: Internal agreement identifier
+  license_id:
+    type:
+      - integer
+      - "null"
+    description: Internal license identifier
+  user_id:
+    type: integer
+    description: Internal patron identifier
+  role:
+    description: role of the user
+    type:
+      - string
+  patron:
+    type:
+      - object
+      - "null"
+additionalProperties: false
+required:
+  - user_id
+  - role

diff --git a/api/v1/swagger/paths/erm_licenses.yaml b/api/v1/swagger/paths/erm_licenses.yaml
index 13b003d..bb32fb9 100644 (file)
--- a/api/v1/swagger/paths/erm_licenses.yaml
+++ b/api/v1/swagger/paths/erm_licenses.yaml
@@ -182,6 +182,8 @@
       permissions:
         erm: 1
     x-koha-embed:
+      - user_roles
+      - user_roles.patron
       - documents
   put:
     x-mojo-to: ERM::Licenses#update
@@ -242,6 +244,7 @@
       permissions:
         erm: 1
     x-koha-embed:
+      - user_roles
       - documents
   delete:
     x-mojo-to: ERM::Licenses#delete