chore(docs): Generated API Reference (#4706)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-08-07 16:54:48 +03:00
committed by GitHub
parent efdea04963
commit 658339767b
1138 changed files with 11740 additions and 7043 deletions

View File

@@ -1,39 +1,45 @@
get:
operationId: GetOrderEdits
summary: List OrderEdits
description: List OrderEdits.
summary: List Order Edits
description: >-
Retrieve a list of order edits. The order edits can be filtered by fields
such as `q` or `order_id`. The order edits can also be paginated.
x-authenticated: true
parameters:
- in: query
name: q
description: Query used for searching order edit internal note.
description: term to search order edits' internal note.
schema:
type: string
- in: query
name: order_id
description: List order edits by order id.
description: Filter by order ID
schema:
type: string
- in: query
name: limit
description: The number of items in the response
description: Limit the number of order edits returned.
schema:
type: number
default: '20'
- in: query
name: offset
description: The offset of items in response
description: The number of order edits to skip when retrieving the order edits.
schema:
type: number
default: '0'
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in each returned order
edit.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: >-
Comma-separated fields that should be included in each returned order
edit.
schema:
type: string
x-codegen:
@@ -75,7 +81,7 @@ get:
post:
operationId: PostOrderEdits
summary: Create an OrderEdit
description: Creates an OrderEdit.
description: Create an Order Edit.
requestBody:
content:
application/json: