chore(docs): Refactor API Reference (#1883)
This commit is contained in:
55
docs/api/admin/paths/draft-orders_{id}.yaml
Normal file
55
docs/api/admin/paths/draft-orders_{id}.yaml
Normal file
@@ -0,0 +1,55 @@
|
||||
delete:
|
||||
operationId: DeleteDraftOrdersDraftOrder
|
||||
summary: Delete a Draft Order
|
||||
description: Deletes a Draft Order
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Draft Order.
|
||||
schema:
|
||||
type: string
|
||||
tags:
|
||||
- Draft Order
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The ID of the deleted Draft Order.
|
||||
object:
|
||||
type: string
|
||||
description: The type of the object that was deleted.
|
||||
default: draft-order
|
||||
deleted:
|
||||
type: boolean
|
||||
description: Whether the draft order was deleted successfully or not.
|
||||
default: true
|
||||
get:
|
||||
operationId: GetDraftOrdersDraftOrder
|
||||
summary: Retrieve a Draft Order
|
||||
description: Retrieves a Draft Order.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Draft Order.
|
||||
schema:
|
||||
type: string
|
||||
tags:
|
||||
- Draft Order
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
draft_order:
|
||||
$ref: ../components/schemas/draft-order.yaml
|
||||
Reference in New Issue
Block a user