chore(docs): Updated API Reference (v2) (#8758)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
This commit is contained in:
github-actions[bot]
2024-08-26 08:06:02 +00:00
committed by GitHub
parent bb0fcbad7b
commit cd4063de74
7 changed files with 36 additions and 23 deletions
@@ -124,6 +124,7 @@ properties:
- exchange - exchange
- claim - claim
- edit - edit
- return_request
return_id: return_id:
type: string type: string
title: return_id title: return_id
@@ -12508,18 +12508,12 @@ paths:
description: Comma-separated relations that should be expanded in the returned data. description: Comma-separated relations that should be expanded in the returned data.
- name: fields - name: fields
in: query in: query
description: |- 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.
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 required: false
schema: schema:
type: string type: string
title: fields title: fields
description: |- 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.
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 - name: offset
in: query in: query
description: The number of items to skip when retrieving a list. description: The number of items to skip when retrieving a list.
@@ -12576,6 +12570,10 @@ paths:
'500': '500':
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
x-workflow: requestOrderEditRequestWorkflow x-workflow: requestOrderEditRequestWorkflow
requestBody:
content:
application/json:
schema: {}
/admin/order-edits/{id}/shipping-method: /admin/order-edits/{id}/shipping-method:
post: post:
operationId: PostOrderEditsIdShippingMethod operationId: PostOrderEditsIdShippingMethod
@@ -53671,6 +53669,7 @@ components:
- exchange - exchange
- claim - claim
- edit - edit
- return_request
return_id: return_id:
type: string type: string
title: return_id title: return_id
@@ -22,18 +22,20 @@ post:
data. data.
- name: fields - name: fields
in: query in: query
description: |- description: >-
Comma-separated fields that should be included in the returned data. Comma-separated fields that should be included in the returned data. if
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. a field is prefixed with `+` it will be added to the default fields,
* without prefix it will replace the entire default fields. using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
required: false required: false
schema: schema:
type: string type: string
title: fields title: fields
description: |- description: >-
Comma-separated fields that should be included in the returned data. 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. if a field is prefixed with `+` it will be added to the default
* without prefix it will replace the entire default fields. fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
- name: offset - name: offset
in: query in: query
description: The number of items to skip when retrieving a list. description: The number of items to skip when retrieving a list.
@@ -94,3 +96,7 @@ post:
'500': '500':
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
x-workflow: requestOrderEditRequestWorkflow x-workflow: requestOrderEditRequestWorkflow
requestBody:
content:
application/json:
schema: {}
@@ -124,6 +124,7 @@ properties:
- exchange - exchange
- claim - claim
- edit - edit
- return_request
return_id: return_id:
type: string type: string
title: return_id title: return_id
@@ -20002,6 +20002,7 @@ components:
- exchange - exchange
- claim - claim
- edit - edit
- return_request
return_id: return_id:
type: string type: string
title: return_id title: return_id
@@ -21,18 +21,18 @@
* description: Comma-separated relations that should be expanded in the returned data. * description: Comma-separated relations that should be expanded in the returned data.
* - name: fields * - name: fields
* in: query * in: query
* description: >- * description: Comma-separated fields that should be included in the returned
* Comma-separated fields that should be included in the returned data. * data. if a field is prefixed with `+` it will be added to the default
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. * fields, using `-` will remove it from the default fields. without prefix
* * without prefix it will replace the entire default fields. * it will replace the entire default fields.
* required: false * required: false
* schema: * schema:
* type: string * type: string
* title: fields * title: fields
* description: >- * description: Comma-separated fields that should be included in the returned
* Comma-separated fields that should be included in the returned data. * data. if a field is prefixed with `+` it will be added to the default
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. * fields, using `-` will remove it from the default fields. without prefix
* * without prefix it will replace the entire default fields. * it will replace the entire default fields.
* - name: offset * - name: offset
* in: query * in: query
* description: The number of items to skip when retrieving a list. * description: The number of items to skip when retrieving a list.
@@ -93,6 +93,10 @@
* "500": * "500":
* $ref: "#/components/responses/500_error" * $ref: "#/components/responses/500_error"
* x-workflow: requestOrderEditRequestWorkflow * x-workflow: requestOrderEditRequestWorkflow
* requestBody:
* content:
* application/json:
* schema: {}
* *
*/ */
@@ -126,6 +126,7 @@
* - exchange * - exchange
* - claim * - claim
* - edit * - edit
* - return_request
* return_id: * return_id:
* type: string * type: string
* title: return_id * title: return_id