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

Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
authored and GitHub committed 2024-07-23 13:51:27 +02:00
1 parent 4b09be3a88
commit d71b0bac36
25 files changed
+219 -318

No files matched your search

@@ -1,8 +1,9 @@
type: object type: object
description: SUMMARY
x-schemaName: AdminPostCancelReturnReqSchema
required: required:
- return_id - return_id
- internal_note - internal_note
x-schemaName: AdminPostCancelReturnReqSchema
properties: properties:
return_id: return_id:
type: string type: string
@@ -6876,18 +6876,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.
@@ -6969,8 +6963,6 @@ paths:
tags: tags:
- Notifications - Notifications
responses: responses:
'200':
description: OK
'400': '400':
$ref: '#/components/responses/400_error' $ref: '#/components/responses/400_error'
'401': '401':
@@ -7006,18 +6998,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.
@@ -7055,8 +7041,6 @@ paths:
tags: tags:
- Notifications - Notifications
responses: responses:
'200':
description: OK
'400': '400':
$ref: '#/components/responses/400_error' $ref: '#/components/responses/400_error'
'401': '401':
@@ -25684,18 +25668,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.
@@ -32469,18 +32447,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.
@@ -32523,8 +32495,6 @@ paths:
tags: tags:
- Returns - Returns
responses: responses:
'200':
description: OK
'400': '400':
$ref: '#/components/responses/400_error' $ref: '#/components/responses/400_error'
'401': '401':
@@ -32566,18 +32536,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.
@@ -32620,8 +32584,6 @@ paths:
tags: tags:
- Returns - Returns
responses: responses:
'200':
description: OK
'400': '400':
$ref: '#/components/responses/400_error' $ref: '#/components/responses/400_error'
'401': '401':
@@ -32662,18 +32624,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.
@@ -32711,8 +32667,6 @@ paths:
tags: tags:
- Returns - Returns
responses: responses:
'200':
description: OK
'400': '400':
$ref: '#/components/responses/400_error' $ref: '#/components/responses/400_error'
'401': '401':
@@ -32843,18 +32797,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.
@@ -32892,8 +32840,6 @@ paths:
tags: tags:
- Returns - Returns
responses: responses:
'200':
description: OK
'400': '400':
$ref: '#/components/responses/400_error' $ref: '#/components/responses/400_error'
'401': '401':
@@ -32929,18 +32875,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.
@@ -32983,8 +32923,6 @@ paths:
tags: tags:
- Returns - Returns
responses: responses:
'200':
description: OK
'400': '400':
$ref: '#/components/responses/400_error' $ref: '#/components/responses/400_error'
'401': '401':
@@ -33026,18 +32964,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.
@@ -33080,8 +33012,6 @@ paths:
tags: tags:
- Returns - Returns
responses: responses:
'200':
description: OK
'400': '400':
$ref: '#/components/responses/400_error' $ref: '#/components/responses/400_error'
'401': '401':
@@ -33122,18 +33052,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.
@@ -33171,8 +33095,6 @@ paths:
tags: tags:
- Returns - Returns
responses: responses:
'200':
description: OK
'400': '400':
$ref: '#/components/responses/400_error' $ref: '#/components/responses/400_error'
'401': '401':
@@ -33208,18 +33130,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.
@@ -33262,8 +33178,6 @@ paths:
tags: tags:
- Returns - Returns
responses: responses:
'200':
description: OK
'400': '400':
$ref: '#/components/responses/400_error' $ref: '#/components/responses/400_error'
'401': '401':
@@ -41664,10 +41578,11 @@ components:
description: The order's metadata. description: The order's metadata.
AdminPostCancelReturnReqSchema: AdminPostCancelReturnReqSchema:
type: object type: object
description: SUMMARY
x-schemaName: AdminPostCancelReturnReqSchema
required: required:
- return_id - return_id
- internal_note - internal_note
x-schemaName: AdminPostCancelReturnReqSchema
properties: properties:
return_id: return_id:
type: string type: string
@@ -18,18 +18,20 @@ get:
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.
@@ -115,8 +117,6 @@ get:
tags: tags:
- Notifications - Notifications
responses: responses:
'200':
description: OK
'400': '400':
$ref: ../components/responses/400_error.yaml $ref: ../components/responses/400_error.yaml
'401': '401':
@@ -24,18 +24,20 @@ get:
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.
@@ -77,8 +79,6 @@ get:
tags: tags:
- Notifications - Notifications
responses: responses:
'200':
description: OK
'400': '400':
$ref: ../components/responses/400_error.yaml $ref: ../components/responses/400_error.yaml
'401': '401':
@@ -16,18 +16,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.
@@ -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.
@@ -80,8 +82,6 @@ post:
tags: tags:
- Returns - Returns
responses: responses:
'200':
description: OK
'400': '400':
$ref: ../components/responses/400_error.yaml $ref: ../components/responses/400_error.yaml
'401': '401':
@@ -28,18 +28,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.
@@ -88,8 +90,6 @@ post:
tags: tags:
- Returns - Returns
responses: responses:
'200':
description: OK
'400': '400':
$ref: ../components/responses/400_error.yaml $ref: ../components/responses/400_error.yaml
'401': '401':
@@ -134,18 +134,20 @@ delete:
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.
@@ -188,8 +190,6 @@ delete:
tags: tags:
- Returns - Returns
responses: responses:
'200':
description: OK
'400': '400':
$ref: ../components/responses/400_error.yaml $ref: ../components/responses/400_error.yaml
'401': '401':
@@ -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.
@@ -80,8 +82,6 @@ post:
tags: tags:
- Returns - Returns
responses: responses:
'200':
description: OK
'400': '400':
$ref: ../components/responses/400_error.yaml $ref: ../components/responses/400_error.yaml
'401': '401':
@@ -28,18 +28,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.
@@ -88,8 +90,6 @@ post:
tags: tags:
- Returns - Returns
responses: responses:
'200':
description: OK
'400': '400':
$ref: ../components/responses/400_error.yaml $ref: ../components/responses/400_error.yaml
'401': '401':
@@ -134,18 +134,20 @@ delete:
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.
@@ -188,8 +190,6 @@ delete:
tags: tags:
- Returns - Returns
responses: responses:
'200':
description: OK
'400': '400':
$ref: ../components/responses/400_error.yaml $ref: ../components/responses/400_error.yaml
'401': '401':
@@ -120,18 +120,20 @@ delete:
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.
@@ -173,8 +175,6 @@ delete:
tags: tags:
- Returns - Returns
responses: responses:
'200':
description: OK
'400': '400':
$ref: ../components/responses/400_error.yaml $ref: ../components/responses/400_error.yaml
'401': '401':
@@ -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.
@@ -80,8 +82,6 @@ post:
tags: tags:
- Returns - Returns
responses: responses:
'200':
description: OK
'400': '400':
$ref: ../components/responses/400_error.yaml $ref: ../components/responses/400_error.yaml
'401': '401':
@@ -1,8 +1,9 @@
type: object type: object
description: SUMMARY
x-schemaName: AdminPostCancelReturnReqSchema
required: required:
- return_id - return_id
- internal_note - internal_note
x-schemaName: AdminPostCancelReturnReqSchema
properties: properties:
return_id: return_id:
type: string type: string
@@ -5582,10 +5582,11 @@ components:
description: The order's metadata. description: The order's metadata.
AdminPostCancelReturnReqSchema: AdminPostCancelReturnReqSchema:
type: object type: object
description: SUMMARY
x-schemaName: AdminPostCancelReturnReqSchema
required: required:
- return_id - return_id
- internal_note - internal_note
x-schemaName: AdminPostCancelReturnReqSchema
properties: properties:
return_id: return_id:
type: string type: string
@@ -29,18 +29,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.
@@ -84,8 +84,6 @@
* tags: * tags:
* - Returns * - Returns
* responses: * responses:
* "200":
* description: OK
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
@@ -29,18 +29,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.
@@ -84,8 +84,6 @@
* tags: * tags:
* - Returns * - Returns
* responses: * responses:
* "200":
* description: OK
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
@@ -22,18 +22,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.
@@ -75,8 +75,6 @@
* tags: * tags:
* - Returns * - Returns
* responses: * responses:
* "200":
* description: OK
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
@@ -16,18 +16,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.
@@ -113,8 +113,6 @@
* tags: * tags:
* - Notifications * - Notifications
* responses: * responses:
* "200":
* description: OK
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
@@ -22,18 +22,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.
@@ -75,8 +75,6 @@
* tags: * tags:
* - Notifications * - Notifications
* responses: * responses:
* "200":
* description: OK
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
@@ -15,18 +15,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.
@@ -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.
@@ -79,8 +79,6 @@
* tags: * tags:
* - Returns * - Returns
* responses: * responses:
* "200":
* description: OK
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
@@ -27,18 +27,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.
@@ -87,8 +87,6 @@
* tags: * tags:
* - Returns * - Returns
* responses: * responses:
* "200":
* description: OK
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
@@ -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.
@@ -79,8 +79,6 @@
* tags: * tags:
* - Returns * - Returns
* responses: * responses:
* "200":
* description: OK
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
@@ -27,18 +27,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.
@@ -87,8 +87,6 @@
* tags: * tags:
* - Returns * - Returns
* responses: * responses:
* "200":
* description: OK
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
@@ -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.
@@ -79,8 +79,6 @@
* tags: * tags:
* - Returns * - Returns
* responses: * responses:
* "200":
* description: OK
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
@@ -1,10 +1,11 @@
/** /**
* @schema AdminPostCancelReturnReqSchema * @schema AdminPostCancelReturnReqSchema
* type: object * type: object
* description: SUMMARY
* x-schemaName: AdminPostCancelReturnReqSchema
* required: * required:
* - return_id * - return_id
* - internal_note * - internal_note
* x-schemaName: AdminPostCancelReturnReqSchema
* properties: * properties:
* return_id: * return_id:
* type: string * type: string