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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-12-22 17:09:49 +02:00
committed by GitHub
parent 233d6904f8
commit 4814045036
477 changed files with 17312 additions and 17713 deletions

View File

@@ -33,7 +33,7 @@ get:
type: object
properties:
order:
$ref: ../components/schemas/order.yaml
$ref: ../components/schemas/Order.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -62,71 +62,7 @@ post:
content:
application/json:
schema:
type: object
properties:
email:
description: the email for the order
type: string
billing_address:
description: Billing address
anyOf:
- $ref: ../components/schemas/address_fields.yaml
shipping_address:
description: Shipping address
anyOf:
- $ref: ../components/schemas/address_fields.yaml
items:
description: The Line Items for the order
type: array
items:
$ref: ../components/schemas/line_item.yaml
region:
description: ID of the region where the order belongs
type: string
discounts:
description: Discounts applied to the order
type: array
items:
$ref: ../components/schemas/discount.yaml
customer_id:
description: ID of the customer
type: string
payment_method:
description: payment method chosen for the order
type: object
properties:
provider_id:
type: string
description: ID of the payment provider
data:
description: Data relevant for the given payment method
type: object
shipping_method:
description: The Shipping Method used for shipping the order.
type: object
properties:
provider_id:
type: string
description: The ID of the shipping provider.
profile_id:
type: string
description: The ID of the shipping profile.
price:
type: integer
description: The price of the shipping.
data:
type: object
description: Data relevant to the specific shipping method.
items:
type: array
items:
$ref: ../components/schemas/line_item.yaml
description: Items to ship
no_notification:
description: >-
A flag to indicate if no notifications should be emitted related
to the updated order.
type: boolean
$ref: ../components/schemas/AdminPostOrdersOrderReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
@@ -150,7 +86,7 @@ post:
type: object
properties:
order:
$ref: ../components/schemas/order.yaml
$ref: ../components/schemas/Order.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':