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

2022-12-13 12:52:58 +02:00
parent a77b4a1b7e
commit 52a8e90aac
413 changed files with 11540 additions and 4501 deletions
--- a/docs/api/admin/paths/publishable-api-keys.yaml
+++ b/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