Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ required:
- payment_collections
- items
- shipping_methods
- status
- currency_code
- id
- version
Expand Down Expand Up @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ x-schemaName: AdminOrderPreview
required:
- return_requested_total
- order_change
- status
- currency_code
- id
- version
Expand Down Expand Up @@ -643,3 +644,7 @@ properties:
$ref: ./AdminCustomer.yaml
sales_channel:
$ref: ./AdminSalesChannel.yaml
status:
type: string
title: status
description: The order's status.
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ required:
- sales_channel_id
- email
- currency_code
- status
- items
- shipping_methods
- payment_status
Expand Down Expand Up @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ x-schemaName: StoreOrder
required:
- items
- shipping_methods
- status
- currency_code
- id
- region_id
Expand Down Expand Up @@ -228,3 +229,7 @@ properties:
description: The order's transactions.
items:
$ref: ./BaseOrderTransaction.yaml
status:
type: string
title: status
description: The order's status.
25 changes: 24 additions & 1 deletion www/apps/api-reference/specs/admin/openapi.full.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -47909,6 +47912,7 @@ components:
- payment_collections
- items
- shipping_methods
- status
- currency_code
- id
- version
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -48830,6 +48838,7 @@ components:
required:
- return_requested_total
- order_change
- status
- currency_code
- id
- version
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -55927,6 +55940,7 @@ components:
- sales_channel_id
- email
- currency_code
- status
- items
- shipping_methods
- payment_status
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -62108,6 +62126,7 @@ components:
required:
- items
- shipping_methods
- status
- currency_code
- id
- region_id
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ required:
- payment_collections
- items
- shipping_methods
- status
- currency_code
- id
- version
Expand Down Expand Up @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ x-schemaName: AdminOrderPreview
required:
- return_requested_total
- order_change
- status
- currency_code
- id
- version
Expand Down Expand Up @@ -643,3 +644,7 @@ properties:
$ref: ./AdminCustomer.yaml
sales_channel:
$ref: ./AdminSalesChannel.yaml
status:
type: string
title: status
description: The order's status.
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ required:
- sales_channel_id
- email
- currency_code
- status
- items
- shipping_methods
- payment_status
Expand Down Expand Up @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ x-schemaName: StoreOrder
required:
- items
- shipping_methods
- status
- currency_code
- id
- region_id
Expand Down Expand Up @@ -228,3 +229,7 @@ properties:
description: The order's transactions.
items:
$ref: ./BaseOrderTransaction.yaml
status:
type: string
title: status
description: The order's status.
25 changes: 24 additions & 1 deletion www/apps/api-reference/specs/store/openapi.full.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,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 customer 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
Expand Down Expand Up @@ -10530,6 +10533,7 @@ components:
- payment_collections
- items
- shipping_methods
- status
- currency_code
- id
- version
Expand Down Expand Up @@ -10760,6 +10764,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.
Expand Down Expand Up @@ -11451,6 +11459,7 @@ components:
required:
- return_requested_total
- order_change
- status
- currency_code
- id
- version
Expand Down Expand Up @@ -12062,6 +12071,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.
Expand Down Expand Up @@ -18548,6 +18561,7 @@ components:
- sales_channel_id
- email
- currency_code
- status
- items
- shipping_methods
- payment_status
Expand Down Expand Up @@ -18769,6 +18783,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.
Expand Down Expand Up @@ -24729,6 +24747,7 @@ components:
required:
- items
- shipping_methods
- status
- currency_code
- id
- region_id
Expand Down Expand Up @@ -24953,6 +24972,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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 customer
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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,12 @@
* 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,12 @@
* 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 customer 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
Expand Down
5 changes: 5 additions & 0 deletions www/utils/generated/oas-output/schemas/AdminOrder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
* - payment_collections
* - items
* - shipping_methods
* - status
* - currency_code
* - id
* - version
Expand Down Expand Up @@ -237,6 +238,10 @@
* 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.
*
*/

Loading
Loading