docs: generate OAS manually for 2.7.0 (#12158)
* original changes * changes * fixes for delete operations * generate oas
This commit is contained in:
@@ -40,10 +40,10 @@ post:
|
||||
will override the provider's `callbackUrl` configurations in
|
||||
`medusa-config.ts`.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: EmailPass Provider
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/Shell/auth_customer_{auth_provider}/post.sh
|
||||
$ref: ../code_samples/JavaScript/auth_customer_{auth_provider}/post.js
|
||||
- lang: Bash
|
||||
label: Google Provider
|
||||
source:
|
||||
|
||||
@@ -28,14 +28,16 @@ post:
|
||||
type: string
|
||||
example: google
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
- lang: JavaScript
|
||||
label: Google Provider
|
||||
source:
|
||||
$ref: ../code_samples/Shell/auth_customer_{auth_provider}_callback/post.sh
|
||||
- lang: Bash
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/auth_customer_{auth_provider}_callback/post.js
|
||||
- lang: TypeScript
|
||||
label: GitHub Provider
|
||||
source:
|
||||
$ref: ../code_samples/Bash/auth_customer_{auth_provider}_callback/post.sh
|
||||
$ref: >-
|
||||
../code_samples/TypeScript/auth_customer_{auth_provider}_callback/post.ts
|
||||
tags:
|
||||
- Auth
|
||||
responses:
|
||||
|
||||
@@ -30,6 +30,11 @@ post:
|
||||
email: customer@gmail.com
|
||||
password: supersecret
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/auth_customer_{auth_provider}_register/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -44,6 +44,11 @@ post:
|
||||
customer's email.
|
||||
example: customer@gmail.com
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/auth_customer_{auth_provider}_reset-password/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -34,6 +34,11 @@ post:
|
||||
email: customer@gmail.com
|
||||
password: supersecret
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/auth_customer_{auth_provider}_update/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -42,6 +42,10 @@ delete:
|
||||
description: Deletes the cookie session ID previously set for authentication.
|
||||
x-authenticated: true
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/auth_session/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -12,6 +12,10 @@ post:
|
||||
description: 'Storefront development: Implement third-party (social) login.'
|
||||
x-authenticated: true
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/auth_token_refresh/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -47,6 +47,10 @@ post:
|
||||
`additional_data` parameter.
|
||||
description: The cart's details.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_carts/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -39,6 +39,10 @@ get:
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_carts_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -125,6 +129,10 @@ post:
|
||||
`additional_data` parameter.
|
||||
description: The properties to update in the cart item.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_carts_{id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -41,6 +41,10 @@ post:
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_carts_{id}_complete/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -46,6 +46,10 @@ post:
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_carts_{id}_customer/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -47,6 +47,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/StoreAddCartLineItem.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_carts_{id}_line-items/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -53,6 +53,11 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/StoreUpdateCartLineItem.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -129,6 +134,11 @@ delete:
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -140,3 +140,8 @@ delete:
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: updateCartPromotionsWorkflow
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/StoreCartRemovePromotion.yaml
|
||||
|
||||
@@ -66,6 +66,10 @@ post:
|
||||
https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping#data-request-body-parameter
|
||||
description: Learn more about the data parameter.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_carts_{id}_shipping-methods/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -672,6 +672,10 @@ get:
|
||||
type: object
|
||||
title: $or
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_collections/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -43,6 +43,10 @@ get:
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_collections_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -43,6 +43,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/StoreCreateCustomer.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_customers/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -41,6 +41,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_customers_me/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -111,6 +115,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/StoreUpdateCustomer.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_customers_me/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -128,6 +128,10 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_customers_me_addresses/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -260,6 +264,10 @@ post:
|
||||
type: object
|
||||
description: Holds custom key-value pairs.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_customers_me_addresses/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -43,6 +43,11 @@ get:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/store_customers_me_addresses_{address_id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -181,6 +186,11 @@ post:
|
||||
type: object
|
||||
description: Holds custom key-value pairs.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/store_customers_me_addresses_{address_id}/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
@@ -255,6 +265,11 @@ delete:
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/store_customers_me_addresses_{address_id}/delete.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -134,6 +134,10 @@ get:
|
||||
- draft
|
||||
- archived
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_orders/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -39,6 +39,10 @@ get:
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_orders_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -52,6 +52,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/StoreAcceptOrderTransfer.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_orders_{id}_transfer_accept/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -44,6 +44,10 @@ post:
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_orders_{id}_transfer_cancel/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -48,6 +48,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/StoreDeclineOrderTransferRequest.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_orders_{id}_transfer_decline/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -49,6 +49,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/StoreRequestOrderTransfer.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_orders_{id}_transfer_request/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -42,6 +42,10 @@ post:
|
||||
schema:
|
||||
$ref: ../components/schemas/StoreCreatePaymentCollection.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_payment-collections/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -80,6 +80,10 @@ get:
|
||||
title: region_id
|
||||
description: Filter by a region ID.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_payment-providers/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -753,6 +753,10 @@ get:
|
||||
title: name
|
||||
description: A product category name.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_product-categories/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -83,6 +83,10 @@ get:
|
||||
or select specific fields to make the response size smaller. For
|
||||
example, `fields=category_children.id,category_children.name`.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_product-categories_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -838,6 +838,10 @@ get:
|
||||
title: cart_id
|
||||
description: The product's cart id.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_products/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -133,6 +133,10 @@ get:
|
||||
externalDocs:
|
||||
url: '#pagination'
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_products_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -149,6 +149,10 @@ get:
|
||||
type: object
|
||||
title: $or
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_regions/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -39,6 +39,10 @@ get:
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_regions_{id}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -117,6 +117,10 @@ get:
|
||||
title: is_return
|
||||
description: Whether the shipping option can be used for returns.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/store_shipping-options/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
@@ -60,6 +60,11 @@ post:
|
||||
url: >-
|
||||
https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: >-
|
||||
../code_samples/JavaScript/store_shipping-options_{id}_calculate/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
|
||||
Reference in New Issue
Block a user