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]
2024-07-25 07:02:12 +00:00
committed by GitHub
parent 9f6a9620c7
commit 13855e9167
7 changed files with 19 additions and 48 deletions
@@ -2,13 +2,8 @@ type: object
description: SUMMARY
x-schemaName: AdminPostCancelReturnReqSchema
required:
- return_id
- internal_note
properties:
return_id:
type: string
title: return_id
description: The return's return id.
no_notification:
type: boolean
title: no_notification
@@ -25751,18 +25751,12 @@ paths:
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.
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.
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.
@@ -41685,13 +41679,8 @@ components:
description: SUMMARY
x-schemaName: AdminPostCancelReturnReqSchema
required:
- return_id
- internal_note
properties:
return_id:
type: string
title: return_id
description: The return's return id.
no_notification:
type: boolean
title: no_notification
@@ -16,18 +16,20 @@ post:
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.
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: |-
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.
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.
@@ -2,13 +2,8 @@ type: object
description: SUMMARY
x-schemaName: AdminPostCancelReturnReqSchema
required:
- return_id
- internal_note
properties:
return_id:
type: string
title: return_id
description: The return's return id.
no_notification:
type: boolean
title: no_notification
@@ -5600,13 +5600,8 @@ components:
description: SUMMARY
x-schemaName: AdminPostCancelReturnReqSchema
required:
- return_id
- internal_note
properties:
return_id:
type: string
title: return_id
description: The return's return id.
no_notification:
type: boolean
title: no_notification
@@ -15,18 +15,18 @@
* 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.
* 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.
* 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.
@@ -4,13 +4,8 @@
* description: SUMMARY
* x-schemaName: AdminPostCancelReturnReqSchema
* required:
* - return_id
* - internal_note
* properties:
* return_id:
* type: string
* title: return_id
* description: The return's return id.
* no_notification:
* type: boolean
* title: no_notification