Bug 33145: Fix ERM swagger specs

This patch adds the missing 'Provider name' parameter definition to the
various ERM paths that were missing it.

Test plan
1) Run:
   docker run --rm -v $PWD/api/v1/swagger:/swagger \
          jeanberu/swagger-cli \
          swagger-cli validate swagger/swagger.yaml
=> FAIL: The spec is not valid!
2) Apply this patch
3) Repeat 1
=> SUCCESS: Tests pass!

Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Edit: tcohen edited the test plan because of the failure to install
swagger-cli cleanly
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

diff --git a/api/v1/swagger/paths/erm_eholdings_packages.yaml b/api/v1/swagger/paths/erm_eholdings_packages.yaml
index 604f6bb..51899e3 100644 (file)
--- a/api/v1/swagger/paths/erm_eholdings_packages.yaml
+++ b/api/v1/swagger/paths/erm_eholdings_packages.yaml
@@ -113,6 +113,11 @@
     produces:
       - application/json
     parameters:
+      - description: Provider name
+        in: path
+        name: provider
+        required: true
+        type: string
       - description: A JSON object containing information about the new package
         in: body
         name: body
@@ -229,6 +234,11 @@
     produces:
       - application/json
     parameters:
+      - description: Provider name
+        in: path
+        name: provider
+        required: true
+        type: string
       - $ref: "../swagger.yaml#/parameters/eholdings_package_id_pp"
       - name: body
         in: body
@@ -291,6 +301,11 @@
     produces:
       - application/json
     parameters:
+      - description: Provider name
+        in: path
+        name: provider
+        required: true
+        type: string
       - $ref: "../swagger.yaml#/parameters/eholdings_package_id_pp"
     responses:
       204:

diff --git a/api/v1/swagger/paths/erm_eholdings_titles.yaml b/api/v1/swagger/paths/erm_eholdings_titles.yaml
index d09627b..b8a58df 100644 (file)
--- a/api/v1/swagger/paths/erm_eholdings_titles.yaml
+++ b/api/v1/swagger/paths/erm_eholdings_titles.yaml
@@ -190,6 +190,11 @@
     produces:
       - application/json
     parameters:
+      - description: Provider name
+        in: path
+        name: provider
+        required: true
+        type: string
       - description: A JSON object containing information about the new title
         in: body
         name: body
@@ -304,6 +309,11 @@
     produces:
       - application/json
     parameters:
+      - description: Provider name
+        in: path
+        name: provider
+        required: true
+        type: string
       - $ref: "../swagger.yaml#/parameters/eholdings_title_id_pp"
       - name: body
         in: body
@@ -366,6 +376,11 @@
     produces:
       - application/json
     parameters:
+      - description: Provider name
+        in: path
+        name: provider
+        required: true
+        type: string
       - $ref: "../swagger.yaml#/parameters/eholdings_title_id_pp"
     responses:
       204:
@@ -403,7 +418,6 @@
     x-koha-authorization:
       permissions:
         erm: 1
-
 /erm/eholdings/local/titles/import:
   post:
     x-mojo-to: ERM::EHoldings::Titles#import_from_list

diff --git a/api/v1/swagger/paths/erm_eholdings_titles_resources.yaml b/api/v1/swagger/paths/erm_eholdings_titles_resources.yaml
index 1a871bf..d5ce1e6 100644 (file)
--- a/api/v1/swagger/paths/erm_eholdings_titles_resources.yaml
+++ b/api/v1/swagger/paths/erm_eholdings_titles_resources.yaml
@@ -9,6 +9,11 @@
     produces:
       - application/json
     parameters:
+      - description: Provider name
+        in: path
+        name: provider
+        required: true
+        type: string
       - description: Case insensitive search on resource_id
         in: query
         name: resource_id