chore(docs): Generated API reference (#2788)

docs/api/admin/paths/admin_draft-orders_{id}.yaml

@@ -14,6 +14,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             region_id:
               type: string
@@ -78,6 +79,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               draft_order:
                 $ref: ../components/schemas/draft-order.yaml

docs/api/admin/paths/apps.yaml

@@ -19,6 +19,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               apps:
                 type: array

docs/api/admin/paths/apps_authorizations.yaml

@@ -7,6 +7,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - application_name
             - state
@@ -37,6 +38,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               apps:
                 $ref: ../components/schemas/OAuth.yaml

docs/api/admin/paths/auth.yaml

@@ -36,6 +36,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               user:
                 $ref: ../components/schemas/user.yaml
@@ -110,6 +111,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               user:
                 $ref: ../components/schemas/user.yaml

docs/api/admin/paths/batch-jobs.yaml

@@ -7,6 +7,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - type
             - context
@@ -62,6 +63,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               batch_job:
                 $ref: ../components/schemas/batch_job.yaml
@@ -338,6 +340,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               batch_jobs:
                 type: array

docs/api/admin/paths/batch-jobs_{id}.yaml

@@ -30,6 +30,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               batch_job:
                 $ref: ../components/schemas/batch_job.yaml

docs/api/admin/paths/batch-jobs_{id}_cancel.yaml

@@ -30,6 +30,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               batch_job:
                 $ref: ../components/schemas/batch_job.yaml

docs/api/admin/paths/batch-jobs_{id}_confirm.yaml

@@ -30,6 +30,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               batch_job:
                 $ref: ../components/schemas/batch_job.yaml

docs/api/admin/paths/collections.yaml

@@ -7,6 +7,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - title
           properties:
@@ -43,6 +44,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               collection:
                 $ref: ../components/schemas/product_collection.yaml
@@ -182,6 +184,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               collections:
                 type: array

docs/api/admin/paths/collections_{id}.yaml

@@ -30,6 +30,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               id:
                 type: string
@@ -86,6 +87,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               collection:
                 $ref: ../components/schemas/product_collection.yaml
@@ -117,6 +119,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             title:
               type: string
@@ -151,6 +154,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               collection:
                 $ref: ../components/schemas/product_collection.yaml

docs/api/admin/paths/collections_{id}_products_batch.yaml

@@ -14,6 +14,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - product_ids
           properties:
@@ -39,6 +40,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               collection:
                 $ref: ../components/schemas/product_collection.yaml
@@ -70,6 +72,7 @@ delete:
     content:
       application/json:
         schema:
+          type: object
           required:
             - product_ids
           properties:
@@ -95,6 +98,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               id:
                 type: string

docs/api/admin/paths/currencies.yaml

@@ -48,6 +48,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               currencies:
                 type: array

docs/api/admin/paths/currencies_{code}.yaml

@@ -14,6 +14,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             includes_tax:
               type: boolean
@@ -35,6 +36,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               currency:
                 $ref: ../components/schemas/currency.yaml

docs/api/admin/paths/customer-groups.yaml

@@ -24,6 +24,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               customer_group:
                 $ref: ../components/schemas/customer_group.yaml
@@ -195,6 +196,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               customer_groups:
                 type: array

docs/api/admin/paths/customer-groups_{id}.yaml

@@ -30,6 +30,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               id:
                 type: string
@@ -96,6 +97,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               customer_group:
                 $ref: ../components/schemas/customer_group.yaml
@@ -127,6 +129,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             name:
               description: Name of the customer group
@@ -154,6 +157,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               customer_group:
                 $ref: ../components/schemas/customer_group.yaml

docs/api/admin/paths/customer-groups_{id}_customers.yaml

@@ -30,6 +30,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               customers:
                 type: array

docs/api/admin/paths/customer-groups_{id}_customers_batch.yaml

@@ -14,6 +14,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - customer_ids
           properties:
@@ -49,6 +50,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               customer_group:
                 $ref: ../components/schemas/customer_group.yaml
@@ -80,6 +82,7 @@ delete:
     content:
       application/json:
         schema:
+          type: object
           required:
             - customer_ids
           properties:
@@ -115,6 +118,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               customer_group:
                 $ref: ../components/schemas/customer_group.yaml

docs/api/admin/paths/customers.yaml

@@ -7,6 +7,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - email
             - first_name
@@ -55,6 +56,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               customer:
                 $ref: ../components/schemas/customer.yaml
@@ -118,6 +120,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               customers:
                 type: array

docs/api/admin/paths/customers_{id}.yaml

@@ -40,6 +40,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               customer:
                 $ref: ../components/schemas/customer.yaml
@@ -81,6 +82,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             email:
               type: string
@@ -134,6 +136,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               customer:
                 $ref: ../components/schemas/customer.yaml

docs/api/admin/paths/discounts.yaml

@@ -20,9 +20,11 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - code
             - rule
+            - regions
           properties:
             code:
               type: string
@@ -173,6 +175,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               discount:
                 $ref: ../components/schemas/discount.yaml
@@ -270,6 +273,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               discounts:
                 type: array

docs/api/admin/paths/discounts_code_{code}.yaml

@@ -40,6 +40,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               discount:
                 $ref: ../components/schemas/discount.yaml

docs/api/admin/paths/discounts_{discount_id}_conditions.yaml

@@ -31,6 +31,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - operator
           properties:
@@ -94,6 +95,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               discount:
                 $ref: ../components/schemas/discount.yaml

docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}.yaml

@@ -48,6 +48,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               id:
                 type: string
@@ -127,6 +128,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               discount_condition:
                 $ref: ../components/schemas/discount_condition.yaml
@@ -181,6 +183,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             products:
               type: array
@@ -237,6 +240,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               discount:
                 $ref: ../components/schemas/discount.yaml

docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}_batch.yaml

@@ -34,6 +34,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - resources
           properties:
@@ -69,6 +70,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               discount:
                 $ref: ../components/schemas/discount.yaml
@@ -120,6 +122,7 @@ delete:
     content:
       application/json:
         schema:
+          type: object
           required:
             - resources
           properties:
@@ -155,6 +158,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               discount:
                 $ref: ../components/schemas/discount.yaml

docs/api/admin/paths/discounts_{id}.yaml

@@ -30,6 +30,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               id:
                 type: string
@@ -96,6 +97,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               discount:
                 $ref: ../components/schemas/discount.yaml
@@ -143,6 +145,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             code:
               type: string
@@ -276,6 +279,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               discount:
                 $ref: ../components/schemas/discount.yaml

docs/api/admin/paths/discounts_{id}_dynamic-codes.yaml

@@ -32,6 +32,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               discount:
                 $ref: ../components/schemas/discount.yaml

docs/api/admin/paths/discounts_{id}_dynamic-codes_{code}.yaml

@@ -38,6 +38,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               discount:
                 $ref: ../components/schemas/discount.yaml

docs/api/admin/paths/discounts_{id}_regions_{region_id}.yaml

@@ -37,6 +37,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               discount:
                 $ref: ../components/schemas/discount.yaml
@@ -92,6 +93,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               discount:
                 $ref: ../components/schemas/discount.yaml

docs/api/admin/paths/draft-orders.yaml

@@ -7,6 +7,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - email
             - items
@@ -126,6 +127,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               draft_order:
                 $ref: ../components/schemas/draft-order.yaml
@@ -186,6 +188,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               draft_orders:
                 type: array

docs/api/admin/paths/draft-orders_{id}.yaml

@@ -30,6 +30,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               id:
                 type: string
@@ -86,6 +87,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               draft_order:
                 $ref: ../components/schemas/draft-order.yaml

docs/api/admin/paths/draft-orders_{id}_line-items.yaml

@@ -14,6 +14,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - quantity
           properties:
@@ -55,6 +56,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               draft_order:
                 $ref: ../components/schemas/draft-order.yaml

docs/api/admin/paths/draft-orders_{id}_line-items_{line_id}.yaml

@@ -38,6 +38,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               draft_order:
                 $ref: ../components/schemas/draft-order.yaml
@@ -75,6 +76,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             unit_price:
               description: The potential custom price of the item.
@@ -112,6 +114,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               draft_order:
                 $ref: ../components/schemas/draft-order.yaml

docs/api/admin/paths/draft-orders_{id}_pay.yaml

@@ -30,6 +30,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/draft-order.yaml

docs/api/admin/paths/gift-cards.yaml

@@ -9,6 +9,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - region_id
           properties:
@@ -52,6 +53,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               gift_card:
                 $ref: ../components/schemas/gift_card.yaml
@@ -110,6 +112,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               gift_cards:
                 type: array

docs/api/admin/paths/gift-cards_{id}.yaml

@@ -30,6 +30,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               id:
                 type: string
@@ -86,6 +87,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               gift_card:
                 $ref: ../components/schemas/gift_card.yaml
@@ -119,6 +121,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             balance:
               type: integer
@@ -160,6 +163,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               gift_card:
                 $ref: ../components/schemas/gift_card.yaml

docs/api/admin/paths/invites.yaml

@@ -7,6 +7,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - user
             - role
@@ -76,6 +77,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               invites:
                 type: array

docs/api/admin/paths/invites_accept.yaml

@@ -6,6 +6,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - token
             - user

docs/api/admin/paths/invites_{invite_id}.yaml

@@ -30,6 +30,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               id:
                 type: string

docs/api/admin/paths/notes.yaml

@@ -7,6 +7,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - resource_id
             - resource_type
@@ -41,6 +42,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               note:
                 $ref: ../components/schemas/note.yaml
@@ -99,6 +101,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               notes:
                 type: array

docs/api/admin/paths/notes_{id}.yaml

@@ -30,6 +30,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               id:
                 type: string
@@ -86,6 +87,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               note:
                 $ref: ../components/schemas/note.yaml
@@ -117,6 +119,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - value
           properties:
@@ -143,6 +146,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               note:
                 $ref: ../components/schemas/note.yaml

docs/api/admin/paths/notifications.yaml

@@ -77,6 +77,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               notifications:
                 type: array

docs/api/admin/paths/notifications_{id}_resend.yaml

@@ -16,6 +16,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             to:
               description: >-
@@ -42,6 +43,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               notification:
                 $ref: ../components/schemas/notification.yaml

docs/api/admin/paths/order-edits.yaml

@@ -6,6 +6,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - order_id
           properties:
@@ -36,6 +37,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order_edit:
                 $ref: ../components/schemas/order_edit.yaml
@@ -53,8 +55,8 @@ post:
       $ref: ../components/responses/500_error.yaml
 get:
   operationId: GetOrderEdits
-  summary: List an OrderEdit
-  description: List a OrderEdit.
+  summary: List OrderEdits
+  description: List OrderEdits.
   x-authenticated: true
   parameters:
     - in: query
@@ -109,6 +111,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order_edits:
                 type: array

docs/api/admin/paths/order-edits_{id}.yaml

@@ -30,6 +30,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               id:
                 type: string
@@ -86,6 +87,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order_edit:
                 $ref: ../components/schemas/order_edit.yaml
@@ -117,6 +119,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             internal_note:
               description: An optional note to create or update for the order edit.
@@ -141,6 +144,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order_edit:
                 $ref: ../components/schemas/order_edit.yaml

docs/api/admin/paths/order-edits_{id}_cancel.yaml

@@ -30,6 +30,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order_edit:
                 $ref: ../components/schemas/order_edit.yaml

docs/api/admin/paths/order-edits_{id}_changes_{change_id}.yaml

@@ -38,6 +38,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               id:
                 type: string

docs/api/admin/paths/order-edits_{id}_confirm.yaml

@@ -30,6 +30,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order_edit:
                 $ref: ../components/schemas/order_edit.yaml

docs/api/admin/paths/order-edits_{id}_items.yaml

@@ -13,6 +13,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - variant_id
             - quantity
@@ -49,6 +50,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order_edit:
                 $ref: ../components/schemas/order_edit.yaml

docs/api/admin/paths/order-edits_{id}_items_{item_id}.yaml

@@ -37,6 +37,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order_edit:
                 $ref: ../components/schemas/order_edit.yaml
@@ -74,6 +75,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - quantity
           properties:
@@ -101,6 +103,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order_edit:
                 $ref: ../components/schemas/order_edit.yaml

docs/api/admin/paths/order-edits_{id}_request.yaml

@@ -30,6 +30,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order_edit:
                 $ref: ../components/schemas/order_edit.yaml

docs/api/admin/paths/order_{id}_claims.yaml

@@ -14,6 +14,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - type
             - claim_items
@@ -151,6 +152,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/order_{id}_claims_{claim_id}.yaml

@@ -20,6 +20,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             claim_items:
               description: The Claim Items that the Claim will consist of.
@@ -127,6 +128,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/order_{id}_swaps.yaml

@@ -16,6 +16,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - return_items
           properties:
@@ -114,6 +115,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders.yaml

@@ -237,6 +237,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               orders:
                 type: array

docs/api/admin/paths/orders_{id}.yaml

@@ -30,6 +30,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml
@@ -61,6 +62,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             email:
               description: the email for the order
@@ -145,6 +147,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_archive.yaml

@@ -30,6 +30,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_cancel.yaml

@@ -33,6 +33,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_capture.yaml

@@ -30,6 +30,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_claims_{claim_id}_cancel.yaml

@@ -38,6 +38,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments.yaml

@@ -20,6 +20,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             metadata:
               description: >-
@@ -53,6 +54,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml

@@ -44,6 +44,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_claims_{claim_id}_shipments.yaml

@@ -20,6 +20,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - fulfillment_id
           properties:
@@ -53,6 +54,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_complete.yaml

@@ -30,6 +30,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_fulfillment.yaml

@@ -16,6 +16,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - items
           properties:
@@ -63,6 +64,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml

@@ -38,6 +38,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_refund.yaml

@@ -14,6 +14,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - amount
             - reason
@@ -52,6 +53,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_return.yaml

@@ -16,6 +16,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - items
           properties:
@@ -89,6 +90,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_shipment.yaml

@@ -14,6 +14,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - fulfillment_id
           properties:
@@ -50,6 +51,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_shipping-methods.yaml

@@ -32,6 +32,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_swaps_{swap_id}_cancel.yaml

@@ -37,6 +37,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments.yaml

@@ -20,6 +20,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             metadata:
               description: >-
@@ -53,6 +54,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml

@@ -44,6 +44,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_swaps_{swap_id}_process-payment.yaml

@@ -41,6 +41,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/orders_{id}_swaps_{swap_id}_shipments.yaml

@@ -20,6 +20,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - fulfillment_id
           properties:
@@ -58,6 +59,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               order:
                 $ref: ../components/schemas/order.yaml

docs/api/admin/paths/payment-collections_{id}.yaml

@@ -0,0 +1,171 @@
+delete:
+  operationId: DeletePaymentCollectionsPaymentCollection
+  summary: Delete a Payment Collection
+  description: Deletes a Payment Collection
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the Payment Collection to delete.
+      schema:
+        type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/payment-collections_{id}/deleteundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/payment-collections_{id}/deleteundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - PaymentCollection
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              id:
+                type: string
+                description: The ID of the deleted Payment Collection.
+              object:
+                type: string
+                description: The type of the object that was deleted.
+                format: payment_collection
+              deleted:
+                type: boolean
+                description: Whether or not the Payment Collection was deleted.
+                default: true
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+get:
+  operationId: GetPaymentCollectionsPaymentCollection
+  summary: Retrieve an PaymentCollection
+  description: Retrieves a PaymentCollection.
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the PaymentCollection.
+      schema:
+        type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the results.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the results.
+      schema:
+        type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/payment-collections_{id}/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/payment-collections_{id}/getundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - PaymentCollection
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              payment_collection:
+                $ref: ../components/schemas/payment_collection.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
+post:
+  operationId: PostPaymentCollectionsPaymentCollection
+  summary: Updates a PaymentCollection
+  description: Updates a PaymentCollection.
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the PaymentCollection.
+      schema:
+        type: string
+  requestBody:
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            description:
+              description: >-
+                An optional description to create or update the payment
+                collection.
+              type: string
+            metadata:
+              description: >-
+                An optional set of key-value pairs to hold additional
+                information.
+              type: object
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/payment-collections_{id}/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/payment-collections_{id}/postundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - PaymentCollection
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              payment_collection:
+                $ref: ../components/schemas/payment_collection.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

docs/api/admin/paths/payment-collections_{id}_authorize.yaml

@@ -0,0 +1,49 @@
+post:
+  operationId: PostPaymentCollectionsPaymentCollectionAuthorize
+  summary: Set the status of PaymentCollection as Authorized
+  description: Sets the status of PaymentCollection as Authorized.
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the PaymentCollection.
+      schema:
+        type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: >-
+          ../code_samples/JavaScript/payment-collections_{id}_authorize/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/payment-collections_{id}_authorize/postundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - PaymentCollection
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              payment_collection:
+                $ref: ../components/schemas/payment_collection.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

docs/api/admin/paths/payments_{id}.yaml

@@ -0,0 +1,48 @@
+get:
+  operationId: GetPaymentsPayment
+  summary: Get Payment details
+  description: Retrieves the Payment details
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the Payment.
+      schema:
+        type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/payments_{id}/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/payments_{id}/getundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - Payment
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              payment:
+                $ref: ../components/schemas/payment.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

docs/api/admin/paths/payments_{id}_capture.yaml

@@ -0,0 +1,48 @@
+post:
+  operationId: PostPaymentsPaymentCapture
+  summary: Capture a Payment
+  description: Captures a Payment.
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the Payment.
+      schema:
+        type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/payments_{id}_capture/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/payments_{id}_capture/postundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - Payment
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              payment:
+                $ref: ../components/schemas/payment.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

docs/api/admin/paths/payments_{id}_refund.yaml

@@ -0,0 +1,66 @@
+post:
+  operationId: PostPaymentsPaymentRefunds
+  summary: Create a Refund
+  description: Issues a Refund.
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the Payment.
+      schema:
+        type: string
+  requestBody:
+    content:
+      application/json:
+        schema:
+          type: object
+          required:
+            - amount
+            - reason
+          properties:
+            amount:
+              description: The amount to refund.
+              type: integer
+            reason:
+              description: The reason for the Refund.
+              type: string
+            note:
+              description: A note with additional details about the Refund.
+              type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/payments_{id}_refund/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/payments_{id}_refund/postundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - Payment
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              refund:
+                $ref: ../components/schemas/refund.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

docs/api/admin/paths/price-lists.yaml

@@ -7,6 +7,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - name
             - description
@@ -105,6 +106,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               price_list:
                 $ref: ../components/schemas/price_list.yaml
@@ -286,6 +288,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               price_lists:
                 type: array

docs/api/admin/paths/price-lists_{id}.yaml

@@ -30,6 +30,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               id:
                 type: string
@@ -86,6 +87,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               price_list:
                 $ref: ../components/schemas/price_list.yaml
@@ -117,6 +119,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             name:
               description: The name of the Price List
@@ -213,6 +216,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               price_list:
                 $ref: ../components/schemas/price_list.yaml

docs/api/admin/paths/price-lists_{id}_prices_batch.yaml

@@ -14,6 +14,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             prices:
               description: The prices to update or add.
@@ -76,6 +77,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               price_list:
                 $ref: ../components/schemas/price_list.yaml
@@ -109,6 +111,7 @@ delete:
     content:
       application/json:
         schema:
+          type: object
           properties:
             price_ids:
               description: The price id's of the Money Amounts to delete.
@@ -136,6 +139,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               ids:
                 type: array

docs/api/admin/paths/price-lists_{id}_products.yaml

@@ -196,6 +196,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               products:
                 type: array

docs/api/admin/paths/price-lists_{id}_products_{product_id}_prices.yaml

@@ -40,6 +40,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               ids:
                 type: array

docs/api/admin/paths/price-lists_{id}_variants_{variant_id}_prices.yaml

@@ -40,6 +40,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               ids:
                 type: array

docs/api/admin/paths/product-tags.yaml

@@ -113,6 +113,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               product_tags:
                 $ref: ../components/schemas/product_tag.yaml

docs/api/admin/paths/product-types.yaml

@@ -113,6 +113,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               product_types:
                 $ref: ../components/schemas/product_type.yaml

docs/api/admin/paths/products.yaml

@@ -7,6 +7,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - title
           properties:
@@ -261,6 +262,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               product:
                 $ref: ../components/schemas/product.yaml
@@ -498,6 +500,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               products:
                 type: array

docs/api/admin/paths/products_tag-usage.yaml

@@ -23,6 +23,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               tags:
                 type: array

docs/api/admin/paths/products_types.yaml

@@ -24,6 +24,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               types:
                 type: array

docs/api/admin/paths/products_{id}.yaml

@@ -30,6 +30,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               id:
                 type: string
@@ -86,6 +87,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               product:
                 $ref: ../components/schemas/product.yaml
@@ -117,6 +119,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           properties:
             title:
               description: The title of the Product
@@ -352,6 +355,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               product:
                 $ref: ../components/schemas/product.yaml

docs/api/admin/paths/products_{id}_metadata.yaml

@@ -14,6 +14,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - key
             - value
@@ -44,6 +45,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               product:
                 $ref: ../components/schemas/product.yaml

docs/api/admin/paths/products_{id}_options.yaml

@@ -14,6 +14,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - title
           properties:
@@ -40,6 +41,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               product:
                 $ref: ../components/schemas/product.yaml

docs/api/admin/paths/products_{id}_options_{option_id}.yaml

@@ -41,6 +41,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               option_id:
                 type: string
@@ -89,6 +90,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - title
           properties:
@@ -116,6 +118,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               product:
                 $ref: ../components/schemas/product.yaml

docs/api/admin/paths/products_{id}_variants.yaml

@@ -16,6 +16,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - title
             - prices
@@ -139,6 +140,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               product:
                 $ref: ../components/schemas/product.yaml
@@ -204,6 +206,7 @@ get:
       content:
         application/json:
           schema:
+            type: object
             properties:
               variants:
                 type: array

docs/api/admin/paths/products_{id}_variants_{variant_id}.yaml

@@ -38,6 +38,7 @@ delete:
       content:
         application/json:
           schema:
+            type: object
             properties:
               variant_id:
                 type: string
@@ -86,6 +87,7 @@ post:
     content:
       application/json:
         schema:
+          type: object
           required:
             - prices
           properties:
@@ -208,6 +210,7 @@ post:
       content:
         application/json:
           schema:
+            type: object
             properties:
               product:
                 $ref: ../components/schemas/product.yaml

docs/api/admin/paths/publishable-api-key_{id}.yaml

@@ -0,0 +1,57 @@
+post:
+  operationId: PostPublishableApiKysPublishableApiKey
+  summary: Updates a PublishableApiKey
+  description: Updates a PublishableApiKey.
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the PublishableApiKey.
+      schema:
+        type: string
+  requestBody:
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            title:
+              description: A title to update for the key.
+              type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/publishable-api-key_{id}/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/publishable-api-key_{id}/postundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - PublishableApiKey
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              publishable_api_key:
+                $ref: ../components/schemas/publishable_api_key.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

docs/api/admin/paths/publishable-api-keys.yaml

@@ -0,0 +1,122 @@
+post:
+  operationId: PostPublishableApiKeys
+  summary: Create a PublishableApiKey
+  description: Creates a PublishableApiKey.
+  requestBody:
+    content:
+      application/json:
+        schema:
+          type: object
+          required:
+            - title
+          properties:
+            title:
+              description: A title for the publishable api key
+              type: string
+  x-authenticated: true
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/publishable-api-keys/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/publishable-api-keys/postundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - PublishableApiKey
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              publishable_api_key:
+                $ref: ../components/schemas/publishable_api_key.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
+get:
+  operationId: GetPublishableApiKeys
+  summary: List PublishableApiKeys
+  description: List PublishableApiKeys.
+  x-authenticated: true
+  parameters:
+    - in: query
+      name: q
+      description: Query used for searching publishable api keys by title.
+      schema:
+        type: string
+    - in: query
+      name: limit
+      description: The number of items in the response
+      schema:
+        type: number
+        default: '20'
+    - in: query
+      name: offset
+      description: The offset of items in response
+      schema:
+        type: number
+        default: '0'
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the results.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the results.
+      schema:
+        type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/publishable-api-keys/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/publishable-api-keys/getundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - PublishableApiKeys
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              publishable_api_keys:
+                type: array
+                $ref: ../components/schemas/publishable_api_key.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

docs/api/admin/paths/publishable-api-keys_:id_sales-channels.yaml

@@ -0,0 +1,44 @@
+get:
+  operationId: GetPublishableApiKeySalesChannels
+  summary: List PublishableApiKey's SalesChannels
+  description: List PublishableApiKey's SalesChannels
+  x-authenticated: true
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: >-
+          ../code_samples/JavaScript/publishable-api-keys_:id_sales-channels/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: >-
+          ../code_samples/Shell/publishable-api-keys_:id_sales-channels/getundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - PublishableApiKeySalesChannels
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            properties:
+              sales_channels:
+                type: array
+                items:
+                  $ref: ../components/schemas/sales_channel.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

docs/api/admin/paths/publishable-api-keys_{id}.yaml

@@ -0,0 +1,95 @@
+delete:
+  operationId: DeletePublishableApiKeysPublishableApiKey
+  summary: Delete a PublishableApiKey
+  description: Deletes a PublishableApiKeys
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the PublishableApiKeys to delete.
+      schema:
+        type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/publishable-api-keys_{id}/deleteundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/publishable-api-keys_{id}/deleteundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - PublishableApiKey
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              id:
+                type: string
+                description: The ID of the deleted PublishableApiKey.
+              object:
+                type: string
+                description: The type of the object that was deleted.
+                format: publishable_api_key
+              deleted:
+                type: boolean
+                description: Whether the PublishableApiKeys was deleted.
+                default: true
+    '400':
+      $ref: ../components/responses/400_error.yaml
+get:
+  operationId: GetPublishableApiKeysPublishableApiKey
+  summary: Get a Publishable API Key
+  description: Retrieve the Publishable Api Key.
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the PublishableApiKey.
+      schema:
+        type: string
+  x-authenticated: true
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/publishable-api-keys_{id}/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/publishable-api-keys_{id}/getundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - PublishableApiKey
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              publishable_api_key:
+                $ref: ../components/schemas/publishable_api_key.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