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

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
This commit is contained in:
github-actions[bot] authored and GitHub committed 2024-07-25 07:02:12 +00:00
1 parent 9f6a9620c7
commit 13855e9167
7 files changed
+19 -48

No files matched your search

@@ -2,13 +2,8 @@ type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminPostCancelReturnReqSchema x-schemaName: AdminPostCancelReturnReqSchema
required: required:
- return_id
- internal_note - internal_note
properties: properties:
return_id:
type: string
title: return_id
description: The return's return id.
no_notification: no_notification:
type: boolean type: boolean
title: no_notification title: no_notification
@@ -25751,18 +25751,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.
@@ -41685,13 +41679,8 @@ components:
description: SUMMARY description: SUMMARY
x-schemaName: AdminPostCancelReturnReqSchema x-schemaName: AdminPostCancelReturnReqSchema
required: required:
- return_id
- internal_note - internal_note
properties: properties:
return_id:
type: string
title: return_id
description: The return's return id.
no_notification: no_notification:
type: boolean type: boolean
title: no_notification title: no_notification
@@ -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.
@@ -2,13 +2,8 @@ type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminPostCancelReturnReqSchema x-schemaName: AdminPostCancelReturnReqSchema
required: required:
- return_id
- internal_note - internal_note
properties: properties:
return_id:
type: string
title: return_id
description: The return's return id.
no_notification: no_notification:
type: boolean type: boolean
title: no_notification title: no_notification
@@ -5600,13 +5600,8 @@ components:
description: SUMMARY description: SUMMARY
x-schemaName: AdminPostCancelReturnReqSchema x-schemaName: AdminPostCancelReturnReqSchema
required: required:
- return_id
- internal_note - internal_note
properties: properties:
return_id:
type: string
title: return_id
description: The return's return id.
no_notification: no_notification:
type: boolean type: boolean
title: no_notification title: no_notification
@@ -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.
@@ -4,13 +4,8 @@
* description: SUMMARY * description: SUMMARY
* x-schemaName: AdminPostCancelReturnReqSchema * x-schemaName: AdminPostCancelReturnReqSchema
* required: * required:
* - return_id
* - internal_note * - internal_note
* properties: * properties:
* return_id:
* type: string
* title: return_id
* description: The return's return id.
* no_notification: * no_notification:
* type: boolean * type: boolean
* title: no_notification * title: no_notification