chore(docs): Generated API Reference (v2) (#8890)

Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-08-30 08:35:10 +02:00
committed by GitHub
co-authored by kodiakhq
parent 891037081d
commit 524be62312
749 changed files with 9092 additions and 52161 deletions
@@ -208,3 +208,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateCartWorkflow
@@ -96,3 +96,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: addToCartWorkflow
@@ -102,6 +102,7 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateLineItemInCartWorkflow
delete:
operationId: DeleteCartsIdLineItemsLine_id
summary: Remove Line Items from Cart
@@ -224,3 +225,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteLineItemsWorkflow
@@ -107,6 +107,7 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateCartPromotionsWorkflow
delete:
operationId: DeleteCartsIdPromotions
summary: Remove Promotions from Cart
@@ -208,3 +209,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateCartPromotionsWorkflow
@@ -107,3 +107,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: addShippingMethodToWorkflow
@@ -96,3 +96,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateTaxLinesWorkflow
@@ -90,3 +90,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createCustomerAccountWorkflow
@@ -185,3 +185,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateCustomersWorkflow
@@ -366,3 +366,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createCustomerAddressesWorkflow
@@ -268,6 +268,7 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateCustomerAddressesWorkflow
delete:
operationId: DeleteCustomersMeAddressesAddress_id
summary: Remove Addresses from Customer
@@ -388,3 +389,4 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteCustomerAddressesWorkflow
@@ -98,3 +98,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createPaymentCollectionForCartWorkflow
@@ -111,3 +111,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createPaymentSessionsWorkflow
@@ -129,7 +129,7 @@ get:
- name: include_ancestors_tree
in: query
description: The product category's include ancestors tree.
required: true
required: false
schema:
type: boolean
title: include_ancestors_tree
@@ -137,7 +137,7 @@ get:
- name: include_descendants_tree
in: query
description: The product category's include descendants tree.
required: true
required: false
schema:
type: boolean
title: include_descendants_tree
@@ -146,104 +146,17 @@ get:
in: query
description: The product category's created at.
required: false
schema:
type: string
description: The product category's created at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: created_at
schema: {}
- name: updated_at
in: query
description: The product category's updated at.
required: false
schema:
type: string
description: The product category's updated at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: updated_at
schema: {}
- name: deleted_at
in: query
description: The product category's deleted at.
required: false
schema:
type: string
description: The product category's deleted at.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties:
$eq: {}
$ne: {}
$in: {}
$nin: {}
$like: {}
$ilike: {}
$re: {}
$contains: {}
$gt: {}
$gte: {}
$lt: {}
$lte: {}
title: deleted_at
schema: {}
- name: $and
in: query
required: false
@@ -70,7 +70,7 @@ get:
- name: include_ancestors_tree
in: query
description: The product category's include ancestors tree.
required: true
required: false
schema:
type: boolean
title: include_ancestors_tree
@@ -78,7 +78,7 @@ get:
- name: include_descendants_tree
in: query
description: The product category's include descendants tree.
required: true
required: false
schema:
type: boolean
title: include_descendants_tree
File diff suppressed because it is too large Load Diff
@@ -3,62 +3,7 @@ post:
summary: Create Return
description: Create a return.
x-authenticated: false
parameters:
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
description: >-
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
required: false
schema:
type: string
title: fields
description: >-
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
parameters: []
requestBody:
content:
application/json:
@@ -90,3 +35,4 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createAndCompleteReturnOrderWorkflow