chore(docs): Generated API Reference (#3061)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2023-01-19 10:06:17 +02:00
parent 3a0f37ef02
commit 296d6e229f
375 changed files with 8467 additions and 5775 deletions
@@ -0,0 +1,57 @@
+get:
+  operationId: GetOrdersOrderReservations
+  summary: Get reservations for an Order
+  description: Retrieves reservations for an Order
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the Order.
+      schema:
+        type: string
+    - in: query
+      name: offset
+      description: How many reservations to skip before the results.
+      schema:
+        type: integer
+        default: 0
+    - in: query
+      name: limit
+      description: Limit the number of reservations returned.
+      schema:
+        type: integer
+        default: 20
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/orders_{id}_reservations/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/orders_{id}_reservations/getundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - Order
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/AdminGetReservationReservationsReq.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml