From de14e5c37a5aad5ce31418c3ae883afef758915c Mon Sep 17 00:00:00 2001
From: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Date: Thu, 6 Jan 2022 13:27:15 +0000
Subject: [PATCH] Bug 29810: Document x-koha-embed header on orders endpoints

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

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Signed-off-by: Fridolin Somers <fridolin.somers@biblibre.com>
---
 api/v1/swagger/paths/acquisitions_orders.yaml | 44 +++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/api/v1/swagger/paths/acquisitions_orders.yaml b/api/v1/swagger/paths/acquisitions_orders.yaml
index cc8411d0ba..1d740858eb 100644
--- a/api/v1/swagger/paths/acquisitions_orders.yaml
+++ b/api/v1/swagger/paths/acquisitions_orders.yaml
@@ -43,6 +43,28 @@
       - $ref: "../swagger.yaml#/parameters/q_body"
       - $ref: "../swagger.yaml#/parameters/q_header"
       - $ref: "../swagger.yaml#/parameters/request_id_header"
+      - name: x-koha-embed
+        in: header
+        required: false
+        description: Embed list sent as a request header
+        type: array
+        items:
+          type: string
+          enum:
+            - basket
+            - basket.basket_group
+            - basket.creator
+            - biblio
+            - biblio.active_orders+count
+            - biblio.holds+count
+            - biblio.items+count
+            - biblio.suggestions.suggester
+            - fund
+            - current_item_level_holds+count
+            - invoice
+            - items
+            - subscription
+        collectionFormat: csv
     responses:
       "200":
         description: A list of orders
@@ -151,6 +173,28 @@
     summary: Get order
     parameters:
       - $ref: "../swagger.yaml#/parameters/order_id_pp"
+      - name: x-koha-embed
+        in: header
+        required: false
+        description: Embed list sent as a request header
+        type: array
+        items:
+          type: string
+          enum:
+            - basket
+            - basket.basket_group
+            - basket.creator
+            - biblio
+            - biblio.active_orders+count
+            - biblio.holds+count
+            - biblio.items+count
+            - biblio.suggestions.suggester
+            - fund
+            - current_item_level_holds+count
+            - invoice
+            - items
+            - subscription
+        collectionFormat: csv
     produces:
       - application/json
     responses:
-- 
2.39.5