chore: generate API reference (#2410)
This commit is contained in:
43
docs/api/store/paths/order-edits_{id}.yaml
Normal file
43
docs/api/store/paths/order-edits_{id}.yaml
Normal file
@@ -0,0 +1,43 @@
|
||||
get:
|
||||
operationId: GetOrderEditsOrderEdit
|
||||
summary: Retrieve an OrderEdit
|
||||
description: Retrieves a OrderEdit.
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the OrderEdit.
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}/getundefined
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/order-edits_{id}/getundefined
|
||||
tags:
|
||||
- OrderEdit
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
order_edit:
|
||||
$ref: ../components/schemas/order_edit.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
39
docs/api/store/paths/order-edits_{id}_complete.yaml
Normal file
39
docs/api/store/paths/order-edits_{id}_complete.yaml
Normal file
@@ -0,0 +1,39 @@
|
||||
post:
|
||||
operationId: PostOrderEditsOrderEditComplete
|
||||
summary: Completes an OrderEdit
|
||||
description: Completes an OrderEdit.
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Order Edit.
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}_complete/postundefined
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/order-edits_{id}_complete/postundefined
|
||||
tags:
|
||||
- OrderEdit
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
order_edit:
|
||||
$ref: ../components/schemas/order_edit.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
47
docs/api/store/paths/order-edits_{id}_decline.yaml
Normal file
47
docs/api/store/paths/order-edits_{id}_decline.yaml
Normal file
@@ -0,0 +1,47 @@
|
||||
post:
|
||||
operationId: PostOrderEditsOrderEditDecline
|
||||
summary: Decline an OrderEdit
|
||||
description: Declines an OrderEdit.
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the OrderEdit.
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
declined_reason:
|
||||
type: string
|
||||
description: The reason for declining the OrderEdit.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/order-edits_{id}_decline/postundefined
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/order-edits_{id}_decline/postundefined
|
||||
tags:
|
||||
- OrderEdit
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
order_edit:
|
||||
$ref: ../components/schemas/order_edit.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
Reference in New Issue
Block a user