docs-util: fixes to OAS generator + generate OAS (#10867)

This commit is contained in:
Shahed Nasser
2025-01-07 16:35:55 +02:00
committed by GitHub
parent 899b1fba4a
commit edcff0ed16
19 changed files with 152 additions and 18 deletions

View File

@@ -5,6 +5,7 @@ required:
- payment_collections
- items
- shipping_methods
- status
- currency_code
- id
- version
@@ -235,3 +236,7 @@ properties:
type: number
title: original_shipping_tax_total
description: The tax total of the order's shipping excluding promotions.
status:
type: string
title: status
description: The order's status.

View File

@@ -6,6 +6,7 @@ x-schemaName: AdminOrderPreview
required:
- return_requested_total
- order_change
- status
- currency_code
- id
- version
@@ -643,3 +644,7 @@ properties:
$ref: ./AdminCustomer.yaml
sales_channel:
$ref: ./AdminSalesChannel.yaml
status:
type: string
title: status
description: The order's status.

View File

@@ -9,6 +9,7 @@ required:
- sales_channel_id
- email
- currency_code
- status
- items
- shipping_methods
- payment_status
@@ -230,3 +231,7 @@ properties:
type: number
title: original_shipping_tax_total
description: The tax total of the order's shipping excluding promotions.
status:
type: string
title: status
description: The order's status.

View File

@@ -4,6 +4,7 @@ x-schemaName: StoreOrder
required:
- items
- shipping_methods
- status
- currency_code
- id
- region_id
@@ -228,3 +229,7 @@ properties:
description: The order's transactions.
items:
$ref: ./BaseOrderTransaction.yaml
status:
type: string
title: status
description: The order's status.

View File

@@ -43329,7 +43329,10 @@ paths:
schema:
type: object
title: input
description: The input data necessary for authentication. For example, for email-pass authentication, pass `email` and `password` properties.
description: |
The input data necessary for authentication.
For example, for email-pass authentication, pass `email` and `password` properties.
For the Google and GitHub authentication providers, you can pass `callback_url` to indicate the URL in the frontend that the user should be redirected to after completing their authentication. This will override the provider's `callbackUrl` configurations in `medusa-config.ts`.
x-codeSamples:
- lang: Shell
label: EmailPass Provider
@@ -47909,6 +47912,7 @@ components:
- payment_collections
- items
- shipping_methods
- status
- currency_code
- id
- version
@@ -48139,6 +48143,10 @@ components:
type: number
title: original_shipping_tax_total
description: The tax total of the order's shipping excluding promotions.
status:
type: string
title: status
description: The order's status.
AdminOrderAddress:
type: object
description: An order address.
@@ -48830,6 +48838,7 @@ components:
required:
- return_requested_total
- order_change
- status
- currency_code
- id
- version
@@ -49441,6 +49450,10 @@ components:
$ref: '#/components/schemas/AdminCustomer'
sales_channel:
$ref: '#/components/schemas/AdminSalesChannel'
status:
type: string
title: status
description: The order's status.
AdminOrderPreviewResponse:
type: object
description: The preview of an order.
@@ -55927,6 +55940,7 @@ components:
- sales_channel_id
- email
- currency_code
- status
- items
- shipping_methods
- payment_status
@@ -56148,6 +56162,10 @@ components:
type: number
title: original_shipping_tax_total
description: The tax total of the order's shipping excluding promotions.
status:
type: string
title: status
description: The order's status.
BaseOrderAddress:
type: object
description: An order address.
@@ -62108,6 +62126,7 @@ components:
required:
- items
- shipping_methods
- status
- currency_code
- id
- region_id
@@ -62332,6 +62351,10 @@ components:
description: The order's transactions.
items:
$ref: '#/components/schemas/BaseOrderTransaction'
status:
type: string
title: status
description: The order's status.
StoreOrderAddress:
type: object
description: An order address

View File

@@ -28,9 +28,17 @@ post:
schema:
type: object
title: input
description: >-
The input data necessary for authentication. For example, for
email-pass authentication, pass `email` and `password` properties.
description: >
The input data necessary for authentication.
For example, for email-pass authentication, pass `email` and
`password` properties.
For the Google and GitHub authentication providers, you can pass
`callback_url` to indicate the URL in the frontend that the user
should be redirected to after completing their authentication. This
will override the provider's `callbackUrl` configurations in
`medusa-config.ts`.
x-codeSamples:
- lang: Shell
label: EmailPass Provider