chore(oas): general fixes to OAS (#9413)

General fixes to OAS
This commit is contained in:
Shahed Nasser
2024-10-02 18:21:40 +03:00
committed by GitHub
parent 34eebb61eb
commit 5fb9c1f82e
9 changed files with 51 additions and 17 deletions

View File

@@ -37,14 +37,10 @@
* "email": "admin@medusa-test.com",
* "password": "supersecret"
* }'
* - lang: Shell
* - lang: Bash
* label: Google Provider
* source: |-
* curl -X POST '{backend_url}/auth/user/google'
* - lang: Shell
* label: GitHub Provider
* source: |-
* curl -X POST '{backend_url}/auth/user/github'
* tags:
* - Auth
* responses:

View File

@@ -27,7 +27,7 @@
* - lang: Shell
* label: Google Provider
* source: curl -X POST '{backend_url}/auth/user/google/callback?code=123'
* - lang: Shell
* - lang: Bash
* label: GitHub Provider
* source: curl -X POST '{backend_url}/auth/user/github/callback?code=123'
* tags:

View File

@@ -37,14 +37,10 @@
* "email": "customer@gmail.com",
* "password": "supersecret"
* }'
* - lang: Shell
* - lang: Bash
* label: Google Provider
* source: |-
* curl -X POST '{backend_url}/auth/customer/google'
* - lang: Shell
* label: GitHub Provider
* source: |-
* curl -X POST '{backend_url}/auth/customer/github'
* tags:
* - Auth
* responses:

View File

@@ -27,7 +27,7 @@
* - lang: Shell
* label: Google Provider
* source: curl -X POST '{backend_url}/auth/customer/google/callback?code=123'
* - lang: Shell
* - lang: Bash
* label: GitHub Provider
* source: curl -X POST '{backend_url}/auth/customer/github/callback?code=123'
* tags:

View File

@@ -32,6 +32,8 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -56,7 +58,7 @@
* type:
* type: string
* title: type
* description: The type of the returned object.
* description: The type of the returned object. In this case, the order is returned because the cart was completed successfully.
* default: order
* order:
* $ref: "#/components/schemas/StoreOrder"
@@ -70,7 +72,7 @@
* type:
* type: string
* title: type
* description: The type of the returned object.
* description: The type of the returned object. In this case, the cart is returned because an error has occurred.
* default: cart
* cart:
* $ref: "#/components/schemas/StoreCart"

View File

@@ -51,7 +51,7 @@
* description: Any additional data relevant for the third-party fulfillment provider to process the shipment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping#data-request-body-parameter
* description: Learn more about the `data` parameter.
* description: Learn more about the data parameter.
* x-codeSamples:
* - lang: Shell
* label: cURL

View File

@@ -6,7 +6,7 @@
* required:
* - location
* properties:
* token:
* location:
* type: string
* title: location
* description: The location to redirect the user to for further authentication with the third-party provider.

View File

@@ -1,7 +1,7 @@
/**
* @schema BaseRegion
* type: object
* description: The parent's region.
* description: The region's details.
* x-schemaName: BaseRegion
* required:
* - id

View File

@@ -37,6 +37,46 @@ class SchemaFactory {
BigNumberValue: {
type: "number",
},
expand: {
type: "string",
title: "expand",
description:
"Comma-separated relations that should be expanded in the returned data.",
},
fields: {
type: "string",
title: "fields",
description:
"Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields.",
externalDocs: {
url: "#select-fields-and-relations",
},
},
offset: {
type: "number",
title: "offset",
description: "The number of items to skip when retrieving a list.",
externalDocs: {
url: "#pagination",
},
},
limit: {
type: "number",
title: "limit",
description: "Limit the number of items returned in the list.",
externalDocs: {
url: "#pagination",
},
},
order: {
type: "string",
title: "order",
description:
"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.",
externalDocs: {
url: "#pagination",
},
},
File: {
type: "object",
description: "A File to upload.",