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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2022-12-22 17:09:49 +02:00
parent 233d6904f8
commit 4814045036
477 changed files with 17312 additions and 17713 deletions
@@ -0,0 +1,34 @@
+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