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,109 @@
+get:
+  operationId: GetCartsCart
+  summary: Retrieve a Cart
+  description: Retrieves a Cart.
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The id of the Cart.
+      schema:
+        type: string
+  tags:
+    - Cart
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            properties:
+              cart:
+                $ref: ../components/schemas/cart.yaml
+post:
+  operationId: PostCartsCart
+  summary: Update a Cart
+  description: Updates a Cart.
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The id of the Cart.
+      schema:
+        type: string
+  requestBody:
+    content:
+      application/json:
+        schema:
+          properties:
+            region_id:
+              type: string
+              description: The id of the Region to create the Cart in.
+            country_code:
+              type: string
+              description: The 2 character ISO country code to create the Cart in.
+              externalDocs:
+                url: >-
+                  https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
+                description: See a list of codes.
+            email:
+              type: string
+              description: An email to be used on the Cart.
+              format: email
+            sales_channel_id:
+              type: string
+              description: The ID of the Sales channel to update the Cart with.
+            billing_address:
+              description: The Address to be used for billing purposes.
+              anyOf:
+                - $ref: ../components/schemas/address.yaml
+                  description: A full billing address object.
+                - type: string
+                  description: The billing address ID
+            shipping_address:
+              description: The Address to be used for shipping.
+              anyOf:
+                - $ref: ../components/schemas/address.yaml
+                  description: A full shipping address object.
+                - type: string
+                  description: The shipping address ID
+            gift_cards:
+              description: An array of Gift Card codes to add to the Cart.
+              type: array
+              items:
+                required:
+                  - code
+                properties:
+                  code:
+                    description: The code that a Gift Card is identified by.
+                    type: string
+            discounts:
+              description: An array of Discount codes to add to the Cart.
+              type: array
+              items:
+                required:
+                  - code
+                properties:
+                  code:
+                    description: The code that a Discount is identifed by.
+                    type: string
+            customer_id:
+              description: The ID of the Customer to associate the Cart with.
+              type: string
+            context:
+              description: An optional object to provide context to the Cart.
+              type: object
+              example:
+                ip: '::1'
+                user_agent: Chrome
+  tags:
+    - Cart
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            properties:
+              cart:
+                $ref: ../components/schemas/cart.yaml