From bb917c3635a31bb2317e2be5d3734da1c605f3ee Mon Sep 17 00:00:00 2001 From: Mirjam Herald Date: Mon, 1 Dec 2025 13:35:41 +0100 Subject: [PATCH] updated CRUD order swaggers for vouchers --- src/openapi/orders/orders-crud.yaml | 102 ++++++++++++++++++++++++++++ 1 file changed, 102 insertions(+) diff --git a/src/openapi/orders/orders-crud.yaml b/src/openapi/orders/orders-crud.yaml index 96866d3..8534ece 100644 --- a/src/openapi/orders/orders-crud.yaml +++ b/src/openapi/orders/orders-crud.yaml @@ -5,6 +5,12 @@ info: description: CRUD APIs for ABT Orders database. These are NOT the functional APIs from Service Engine. servers: - url: https://services.acc.api.htm.nl/abt/abtorder/1.0 +tags: + - name: Order + - name: Order Line + - name: Payment + - name: Customer + - name: Order Voucher paths: /orders: get: @@ -98,6 +104,14 @@ paths: explode: false required: false description: Filter on most recent order status. 1 = concept, 2 = awaitingPayment, 3 = pendingPayment, 4 = paid, 5 = delivered, 6 = cancelled. + - in: query + name: issuedVoucherId + schema: + type: string + format: uuid + example: "b0a9f3c9-9b92-4f8c-b78d-6129be7218a6" + required: false + description: Filter on applied issuedVoucherId for the order. responses: "200": description: OK @@ -678,6 +692,7 @@ paths: responses: "200": description: OK + /orders/{orderId}/statuses: parameters: - in: path @@ -715,6 +730,93 @@ paths: { "order_orderStatusId": "b9cf0096-4211-4be6-ac21-7bc34bc8e066", } + /orders/{orderId}/ordervouchers: + parameters: + - in: path + name: orderId + schema: + type: string + format: uuid + example: d1dd439b-6072-4b97-89c9-724268865b93 + required: true + description: The id of the order to process. + post: + summary: Add an order voucher. + description: Add an order voucher. + tags: + - Order Voucher + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "issuedVoucherId": "eec6af41-1a60-49f6-a92e-440054a92f13", + "orderLineId": "7a9d6e15-7c5c-421d-9ea9-00b9bb6dbe67" + } + responses: + "201": + description: Created + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "order_orderVoucherId": "b9cf0096-4211-4be6-ac21-7bc34bc8e066", + } + /ordervouchers/{order_ordervoucherId}: + parameters: + - in: path + name: order_ordervoucherId + schema: + type: string + format: uuid + example: d1dd439b-6072-4b97-89c9-724268865b93 + required: true + description: The id of the order to process. + patch: + summary: Update an order voucher. + description: Update an order voucher. + tags: + - Order Voucher + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "issuedVoucherId": "eec6af41-1a60-49f6-a92e-440054a92f13", + "orderLineId": "7a9d6e15-7c5c-421d-9ea9-00b9bb6dbe67" + } + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "order_orderVoucherId": "b9cf0096-4211-4be6-ac21-7bc34bc8e066", + } + delete: + summary: Delete an order voucher. + description: Delete an order voucher. + tags: + - Order Voucher + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + } /orders/{orderId}/orderlines: parameters: - in: path