chore(docs): Generated API Reference (#2882)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
co-authored by
olivermrbl
parent
233d6904f8
commit
4814045036
@@ -7,42 +7,7 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- type
|
||||
- context
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
description: The type of batch job to start.
|
||||
example: product-export
|
||||
context:
|
||||
type: object
|
||||
description: >-
|
||||
Additional infomration regarding the batch to be used for
|
||||
processing.
|
||||
example:
|
||||
shape:
|
||||
prices:
|
||||
- region: null
|
||||
currency_code: eur
|
||||
dynamicImageColumnCount: 4
|
||||
dynamicOptionColumnCount: 2
|
||||
list_config:
|
||||
skip: 0
|
||||
take: 50
|
||||
order:
|
||||
created_at: DESC
|
||||
relations:
|
||||
- variants
|
||||
- variant.prices
|
||||
- images
|
||||
dry_run:
|
||||
type: boolean
|
||||
description: >-
|
||||
Set a batch job in dry_run mode to get some information on what
|
||||
will be done without applying any modifications.
|
||||
default: false
|
||||
$ref: ../components/schemas/AdminPostBatchesReq.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
@@ -66,7 +31,7 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
batch_job:
|
||||
$ref: ../components/schemas/batch_job.yaml
|
||||
$ref: ../components/schemas/BatchJob.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -345,7 +310,7 @@ get:
|
||||
batch_jobs:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../components/schemas/batch_job.yaml
|
||||
$ref: ../components/schemas/BatchJob.yaml
|
||||
count:
|
||||
type: integer
|
||||
description: The total number of items available
|
||||
|
||||
Reference in New Issue
Block a user