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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-04-04 21:02:44 +03:00
committed by GitHub
parent 51d0b88404
commit 70435d5631
1031 changed files with 104669 additions and 4209 deletions

View File

@@ -0,0 +1,185 @@
get:
operationId: GetCollections
summary: List Collections
description: Retrieve a list of Product Collection.
x-authenticated: true
parameters:
- in: query
name: limit
description: The number of collections to return.
schema:
type: integer
default: 10
- in: query
name: offset
description: The number of collections to skip before the results.
schema:
type: integer
default: 0
- in: query
name: title
description: The title of collections to return.
schema:
type: string
- in: query
name: handle
description: The handle of collections to return.
schema:
type: string
- in: query
name: q
description: a search term to search titles and handles.
schema:
type: string
- in: query
name: discount_condition_id
description: The discount condition id on which to filter the product collections.
schema:
type: string
- in: query
name: created_at
description: Date comparison for when resulting collections 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 collections 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
- in: query
name: deleted_at
description: Date comparison for when resulting collections were deleted.
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-codegen:
method: list
queryParams: AdminGetCollectionsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_collections/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_collections/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Collections
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminCollectionsListRes.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: PostCollections
summary: Create a Collection
description: Creates a Product Collection.
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostCollectionsReq.yaml
x-codegen:
method: create
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_collections/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_collections/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Collections
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminCollectionsRes.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