Bug 32923: Fix new occurrences of x-koha-embed at top level

Signed-off-by: Pedro Amorim <pedro.amorim@ptfs-europe.com>
Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

api/v1/swagger/paths/biblios_item_groups.yaml

@@ -12,6 +12,16 @@
       description: Internal identifier for the parent bibliographic record
       required: true
       type: string
+    - name: x-koha-embed
+      in: header
+      required: false
+      description: Embed list sent as a request header
+      type: array
+      items:
+        type: string
+        enum:
+          - items
+      collectionFormat: csv
     - "$ref": "../swagger.yaml#/parameters/match"
     - "$ref": "../swagger.yaml#/parameters/order_by"
     - "$ref": "../swagger.yaml#/parameters/page"
@@ -47,8 +57,6 @@
     x-koha-authorization:
       permissions:
         catalogue: "manage_item_groups"
-    x-koha-embed:
-    - items
   post:
     x-mojo-to: Biblios::ItemGroups#add
     operationId: addItemGroup
@@ -131,6 +139,16 @@
       description: Internal identifier for the item_group
       required: true
       type: string
+    - name: x-koha-embed
+      in: header
+      required: false
+      description: Embed list sent as a request header
+      type: array
+      items:
+        type: string
+        enum:
+          - items
+      collectionFormat: csv
     produces:
     - application/yaml
     responses:
@@ -154,8 +172,6 @@
         description: Under maintenance
         schema:
           "$ref": "../swagger.yaml#/definitions/error"
-    x-koha-embed:
-    - items
     x-koha-authorization:
       permissions:
         catalogue: "manage_item_groups"
@@ -190,6 +206,16 @@
             type: integer
             description: Position in waiting queue
         additionalProperties: false
+    - name: x-koha-embed
+      in: header
+      required: false
+      description: Embed list sent as a request header
+      type: array
+      items:
+        type: string
+        enum:
+          - items
+      collectionFormat: csv
     produces:
     - application/yaml
     responses:
@@ -224,8 +250,6 @@
     x-koha-authorization:
       permissions:
         catalogue: "manage_item_groups"
-    x-koha-embed:
-    - items
   delete:
     x-mojo-to: Biblios::ItemGroups#delete
     operationId: deleteItemGroup
@@ -302,6 +326,16 @@
             type: integer
             description: Internal identifier for an item to be linked
         additionalProperties: false
+    - name: x-koha-embed
+      in: header
+      required: false
+      description: Embed list sent as a request header
+      type: array
+      items:
+        type: string
+        enum:
+          - items
+      collectionFormat: csv
     produces:
     - application/yaml
     responses:
@@ -334,8 +368,6 @@
     x-koha-authorization:
       permissions:
         catalogue: "manage_item_groups"
-    x-koha-embed:
-    - items
 "/biblios/{biblio_id}/item_groups/{item_group_id}/items/{item_id}":
   delete:
     x-mojo-to: Biblios::ItemGroups::Items#delete

api/v1/swagger/paths/checkouts.yaml

@@ -235,8 +235,6 @@
     x-koha-authorization:
       permissions:
         circulate: circulate_remaining_permissions
-    x-koha-embed:
-        - renewer
 "/checkouts/{checkout_id}/allows_renewal":
   get:
     x-mojo-to: Checkouts#allows_renewal

api/v1/swagger/paths/erm_agreements.yaml

@@ -165,6 +165,25 @@
       - application/json
     parameters:
       - $ref: "../swagger.yaml#/parameters/agreement_id_pp"
+      - name: x-koha-embed
+        in: header
+        required: false
+        description: Embed list sent as a request header
+        type: array
+        items:
+          type: string
+          enum:
+            - periods
+            - user_roles
+            - user_roles.patron
+            - agreement_licenses
+            - agreement_licenses.license
+            - agreement_relationships
+            - agreement_relationships.agreement
+            - agreement_relationships.related_agreement
+            - documents
+            - packages
+        collectionFormat: csv
     responses:
       200:
         description: An agreement
@@ -196,17 +215,6 @@
     x-koha-authorization:
       permissions:
         erm: 1
-    x-koha-embed:
-      - periods
-      - user_roles
-      - user_roles.patron
-      - agreement_licenses
-      - agreement_licenses.license
-      - agreement_relationships
-      - agreement_relationships.agreement
-      - agreement_relationships.related_agreement
-      - documents
-      - packages
   put:
     x-mojo-to: ERM::Agreements#update
     operationId: updateErmAgreements
@@ -225,7 +233,20 @@
         required: true
         schema:
           $ref: "../swagger.yaml#/definitions/erm_agreement"
-
+      - name: x-koha-embed
+        in: header
+        required: false
+        description: Embed list sent as a request header
+        type: array
+        items:
+          type: string
+          enum:
+            - periods
+            - user_roles
+            - agreement_licenses
+            - agreement_relationships
+            - documents
+        collectionFormat: csv
     responses:
       200:
         description: A successfully updated agreement
@@ -265,12 +286,6 @@
     x-koha-authorization:
       permissions:
         erm: 1
-    x-koha-embed:
-      - periods
-      - user_roles
-      - agreement_licenses
-      - agreement_relationships
-      - documents
   delete:
     x-mojo-to: ERM::Agreements#delete
     operationId: deleteErmAgreements

api/v1/swagger/paths/erm_eholdings_packages.yaml

@@ -61,6 +61,17 @@
       - $ref: "../swagger.yaml#/parameters/q_param"
       - $ref: "../swagger.yaml#/parameters/q_body"
       - $ref: "../swagger.yaml#/parameters/q_header"
+      - name: x-koha-embed
+        in: header
+        required: false
+        description: Embed list sent as a request header
+        type: array
+        items:
+          type: string
+          enum:
+            - vendors
+            - resources+count
+        collectionFormat: csv
     responses:
       200:
         description: A list of package
@@ -89,9 +100,6 @@
     x-koha-authorization:
       permissions:
         erm: 1
-    x-koha-embed:
-      - vendors
-      - resources+count
   post:
     x-mojo-to: ERM::EHoldings::Packages#add
     operationId: addErmEHoldingsPackages
@@ -164,6 +172,17 @@
         required: true
         type: string
       - $ref: "../swagger.yaml#/parameters/eholdings_package_id_pp"
+      - name: x-koha-embed
+        in: header
+        required: false
+        description: Embed list sent as a request header
+        type: array
+        items:
+          type: string
+          enum:
+            - agreements
+            - resources
+        collectionFormat: csv
     responses:
       200:
         description: A package
@@ -195,9 +214,6 @@
     x-koha-authorization:
       permissions:
         erm: 1
-    x-koha-embed:
-      - agreements
-      - resources
   put:
     x-mojo-to: ERM::EHoldings::Packages#update
     operationId: updateErmEHoldingsPackages
@@ -216,6 +232,17 @@
         required: true
         schema:
           $ref: "../swagger.yaml#/definitions/erm_eholdings_package"
+      - name: x-koha-embed
+        in: header
+        required: false
+        description: Embed list sent as a request header
+        type: array
+        items:
+          type: string
+          enum:
+            - agreements
+            - resources
+        collectionFormat: csv
     responses:
       200:
         description: A successfully updated package
@@ -251,9 +278,6 @@
     x-koha-authorization:
       permissions:
         erm: 1
-    x-koha-embed:
-      - agreements
-      - resources
   delete:
     x-mojo-to: ERM::EHoldings::Packages#delete
     operationId: deleteErmEHoldingsPackages

api/v1/swagger/paths/erm_eholdings_packages_resources.yaml

@@ -42,6 +42,16 @@
       - $ref: "../swagger.yaml#/parameters/q_param"
       - $ref: "../swagger.yaml#/parameters/q_body"
       - $ref: "../swagger.yaml#/parameters/q_header"
+      - name: x-koha-embed
+        in: header
+        required: false
+        description: Embed list sent as a request header
+        type: array
+        items:
+          type: string
+          enum:
+            - title.publication_title
+        collectionFormat: csv
     responses:
       200:
         description: A list of eHoldings resources
@@ -70,5 +80,3 @@
     x-koha-authorization:
       permissions:
         erm: 1
-    x-koha-embed:
-      - title.publication_title

api/v1/swagger/paths/erm_eholdings_titles.yaml

@@ -251,6 +251,17 @@
         required: true
         type: string
       - $ref: "../swagger.yaml#/parameters/eholdings_title_id_pp"
+      - name: x-koha-embed
+        in: header
+        required: false
+        description: Embed list sent as a request header
+        type: array
+        items:
+          type: string
+          enum:
+            - resources
+            - resources.package
+        collectionFormat: csv
     responses:
       200:
         description: An eHolding title
@@ -282,9 +293,6 @@
     x-koha-authorization:
       permissions:
         erm: 1
-    x-koha-embed:
-      - resources
-      - resources.package
   put:
     x-mojo-to: ERM::EHoldings::Titles#update
     operationId: updateErmEHoldingsTitles
@@ -303,6 +311,17 @@
         required: true
         schema:
           $ref: "../swagger.yaml#/definitions/erm_eholdings_title"
+      - name: x-koha-embed
+        in: header
+        required: false
+        description: Embed list sent as a request header
+        type: array
+        items:
+          type: string
+          enum:
+            - resources
+            - resources.package
+        collectionFormat: csv
     responses:
       200:
         description: A successfully updated title
@@ -338,9 +357,6 @@
     x-koha-authorization:
       permissions:
         erm: 1
-    x-koha-embed:
-      - resources
-      - resources.package
   delete:
     x-mojo-to: ERM::EHoldings::Titles#delete
     operationId: deleteErmEHoldingsTitles

api/v1/swagger/paths/erm_eholdings_titles_resources.yaml

@@ -37,6 +37,16 @@
       - $ref: "../swagger.yaml#/parameters/q_param"
       - $ref: "../swagger.yaml#/parameters/q_body"
       - $ref: "../swagger.yaml#/parameters/q_header"
+      - name: x-koha-embed
+        in: header
+        required: false
+        description: Embed list sent as a request header
+        type: array
+        items:
+          type: string
+          enum:
+            - title.publication_title
+        collectionFormat: csv
     responses:
       200:
         description: A list of eHoldings resources
@@ -65,5 +75,3 @@
     x-koha-authorization:
       permissions:
         erm: 1
-    x-koha-embed:
-      - title.publication_title

api/v1/swagger/paths/erm_licenses.yaml

@@ -150,6 +150,18 @@
       - application/json
     parameters:
       - $ref: "../swagger.yaml#/parameters/license_id_pp"
+      - name: x-koha-embed
+        in: header
+        required: false
+        description: Embed list sent as a request header
+        type: array
+        items:
+          type: string
+          enum:
+            - user_roles
+            - user_roles.patron
+            - documents
+        collectionFormat: csv
     responses:
       200:
         description: license
@@ -181,10 +193,6 @@
     x-koha-authorization:
       permissions:
         erm: 1
-    x-koha-embed:
-      - user_roles
-      - user_roles.patron
-      - documents
   put:
     x-mojo-to: ERM::Licenses#update
     operationId: updateERMlicenses
@@ -203,7 +211,17 @@
         required: true
         schema:
           $ref: "../swagger.yaml#/definitions/erm_license"
-
+      - name: x-koha-embed
+        in: header
+        required: false
+        description: Embed list sent as a request header
+        type: array
+        items:
+          type: string
+          enum:
+            - user_roles
+            - documents
+        collectionFormat: csv
     responses:
       200:
         description: a successfully updated license
@@ -243,9 +261,6 @@
     x-koha-authorization:
       permissions:
         erm: 1
-    x-koha-embed:
-      - user_roles
-      - documents
   delete:
     x-mojo-to: ERM::Licenses#delete
     operationId: deleteERMlicenses

api/v1/swagger/paths/erm_users.yaml

@@ -15,6 +15,16 @@
       - $ref: "../swagger.yaml#/parameters/q_param"
       - $ref: "../swagger.yaml#/parameters/q_body"
       - $ref: "../swagger.yaml#/parameters/q_header"
+      - name: x-koha-embed
+        in: header
+        required: false
+        description: Embed list sent as a request header
+        type: array
+        items:
+          type: string
+          enum:
+            - extended_attributes
+        collectionFormat: csv
     produces:
       - application/json
     responses:
@@ -46,6 +56,4 @@
     x-koha-authorization:
       permissions:
         erm: 1
-    x-koha-embed:
-      - extended_attributes
 

api/v1/swagger/paths/items.yaml

@@ -221,6 +221,20 @@
       - $ref: "../swagger.yaml#/parameters/q_param"
       - $ref: "../swagger.yaml#/parameters/q_body"
       - $ref: "../swagger.yaml#/parameters/q_header"
+      - name: x-koha-embed
+        in: header
+        required: false
+        description: Embed list sent as a request header
+        type: array
+        items:
+          type: string
+          enum:
+            - biblio
+            - checkout
+            - return_claims
+            - return_claim
+            - return_claim.patron
+        collectionFormat: csv
     consumes:
       - application/json
     produces:
@@ -251,12 +265,6 @@
     x-koha-authorization:
       permissions:
         catalogue: "1"
-    x-koha-embed:
-      - biblio
-      - checkout
-      - return_claims
-      - return_claim
-      - return_claim.patron
 "/items/{item_id}/bundled_items/{bundled_item_id}":
   delete:
     x-mojo-to: Items#remove_from_bundle