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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2023-01-11 18:08:33 +02:00
parent f521260a8f
commit f7e23afff2
51 changed files with 4342 additions and 0 deletions
@@ -0,0 +1,121 @@
+post:
+  operationId: PostSalesChannelsSalesChannelStockLocation
+  summary: Associate a stock location to a Sales Channel
+  description: Associates a stock location to a Sales Channel.
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the Sales Channel.
+      schema:
+        type: string
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: >-
+            ../components/schemas/AdminPostSalesChannelsChannelStockLocationsReq.yaml
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: >-
+          ../code_samples/JavaScript/sales-channels_{id}_stock-locations/postundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: >-
+          ../code_samples/Shell/sales-channels_{id}_stock-locations/postundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - Sales Channel
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              sales_channel:
+                $ref: ../components/schemas/SalesChannel.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
+delete:
+  operationId: DeleteSalesChannelsSalesChannelStockLocation
+  summary: Remove a stock location from a Sales Channel
+  description: Removes a stock location from a Sales Channel.
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the Sales Channel.
+      schema:
+        type: string
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: >-
+            ../components/schemas/AdminDeleteSalesChannelsChannelStockLocationsReq.yaml
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: >-
+          ../code_samples/JavaScript/sales-channels_{id}_stock-locations/deleteundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: >-
+          ../code_samples/Shell/sales-channels_{id}_stock-locations/deleteundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - Sales Channel
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              id:
+                type: string
+                description: The ID of the removed stock location from a sales channel
+              object:
+                type: string
+                description: The type of the object that was removed.
+                default: stock-location
+              deleted:
+                type: boolean
+                description: Whether or not the items were deleted.
+                default: true
+    '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