chore(docs): Refactor API Reference (#1883)

2022-08-05 14:06:12 +02:00
parent b126ab4dec
commit 73383cc466
625 changed files with 52358 additions and 11660 deletions
@@ -0,0 +1,56 @@
+post:
+  operationId: PostOrdersOrderFulfillments
+  summary: Create a Fulfillment
+  description: >-
+    Creates a Fulfillment of an Order - will notify Fulfillment Providers to
+    prepare a shipment.
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the Order.
+      schema:
+        type: string
+  requestBody:
+    content:
+      application/json:
+        schema:
+          required:
+            - items
+          properties:
+            items:
+              description: The Line Items to include in the Fulfillment.
+              type: array
+              items:
+                required:
+                  - item_id
+                  - quantity
+                properties:
+                  item_id:
+                    description: The ID of Line Item to fulfill.
+                    type: string
+                  quantity:
+                    description: The quantity of the Line Item to fulfill.
+                    type: integer
+            no_notification:
+              description: >-
+                If set to true no notification will be send related to this
+                Swap.
+              type: boolean
+            metadata:
+              description: >-
+                An optional set of key-value pairs to hold additional
+                information.
+              type: object
+  tags:
+    - Fulfillment
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            properties:
+              order:
+                $ref: ../components/schemas/order.yaml