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

Co-authored-by: kodiakhq[bot] <kodiakhq[bot]@users.noreply.github.com>
2022-11-28 10:59:43 +02:00
parent 546577a81a
commit 3cee0bc8fc
10 changed files with 464 additions and 3 deletions
--- a/docs/api/store/paths/product-types.yaml
+++ b/docs/api/store/paths/product-types.yaml
@@ -0,0 +1,139 @@
+get:
+  operationId: GetProductTypes
+  summary: List Product Types
+  description: Retrieve a list of Product Types.
+  x-authenticated: true
+  parameters:
+    - in: query
+      name: limit
+      description: The number of types to return.
+      schema:
+        type: integer
+        default: 20
+    - in: query
+      name: offset
+      description: The number of items to skip before the results.
+      schema:
+        type: integer
+        default: 0
+    - in: query
+      name: order
+      description: The field to sort items by.
+      schema:
+        type: string
+    - in: query
+      name: discount_condition_id
+      description: The discount condition id on which to filter the product types.
+      schema:
+        type: string
+    - in: query
+      name: value
+      style: form
+      explode: false
+      description: The type values to search for
+      schema:
+        type: array
+        items:
+          type: string
+    - in: query
+      name: id
+      style: form
+      explode: false
+      description: The type IDs to search for
+      schema:
+        type: array
+        items:
+          type: string
+    - in: query
+      name: q
+      description: A query string to search values for
+      schema:
+        type: string
+    - in: query
+      name: created_at
+      description: Date comparison for when resulting product types were created.
+      schema:
+        type: object
+        properties:
+          lt:
+            type: string
+            description: filter by dates less than this date
+            format: date
+          gt:
+            type: string
+            description: filter by dates greater than this date
+            format: date
+          lte:
+            type: string
+            description: filter by dates less than or equal to this date
+            format: date
+          gte:
+            type: string
+            description: filter by dates greater than or equal to this date
+            format: date
+    - in: query
+      name: updated_at
+      description: Date comparison for when resulting product types were updated.
+      schema:
+        type: object
+        properties:
+          lt:
+            type: string
+            description: filter by dates less than this date
+            format: date
+          gt:
+            type: string
+            description: filter by dates greater than this date
+            format: date
+          lte:
+            type: string
+            description: filter by dates less than or equal to this date
+            format: date
+          gte:
+            type: string
+            description: filter by dates greater than or equal to this date
+            format: date
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/product-types/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/product-types/getundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - Product Type
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            properties:
+              product_types:
+                $ref: ../components/schemas/product_type.yaml
+              count:
+                type: integer
+                description: The total number of items available
+              offset:
+                type: integer
+                description: The number of items skipped before these items
+              limit:
+                type: integer
+                description: The number of items per page
+    '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