asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: fix broken links in OAS (#14000)

Browse Source
This commit is contained in:
Shahed Nasser
2025-11-07 10:48:37 +02:00
committed by GitHub
parent 5a96bb7da4
commit 6cd40c9f74
169 changed files with 291 additions and 300 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}.yaml
+1 -1
View File
@@ -11,7 +11,7 @@ post:
continue authentication with the third-party service.
externalDocs:
url: >-
https://docs.medusajs.com/v2/storefront-development/customers/login#1-using-a-jwt-token
https://docs.medusajs.com/resources/storefront-development/customers/login#1-using-a-jwt-token
description: 'Storefront development: How to login as a customer'
x-authenticated: false
parameters:
www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_callback.yaml
+1 -1
View File
@@ -16,7 +16,7 @@ post:
in the request's Authorization header.
externalDocs:
url: >-
https://docs.medusajs.com/v2/storefront-development/customers/third-party-login
https://docs.medusajs.com/resources/storefront-development/customers/third-party-login
description: 'Storefront development: Implement third-party (social) login.'
x-authenticated: false
parameters:
www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_register.yaml
+2 -1
View File
@@ -6,7 +6,8 @@ post:
been registered yet. The token is used in the header of requests that create
a customer.
externalDocs:
url: https://docs.medusajs.com/v2/storefront-development/customers/register
url: >-
https://docs.medusajs.com/resources/storefront-development/customers/register
description: 'Storefront development: How to register a customer'
x-authenticated: false
parameters:
www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_reset-password.yaml
+1 -1
View File
@@ -21,7 +21,7 @@ post:
Use the generated token to update the customer's password using the [Reset Password API route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_providerupdate).
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password#1-request-reset-password-page
https://docs.medusajs.com/resources/storefront-development/customers/reset-password#1-request-reset-password-page
description: 'Storefront development: How to create the request reset password page.'
x-authenticated: false
parameters:
www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_update.yaml
+1 -1
View File
@@ -9,7 +9,7 @@ post:
You pass the token as a bearer token in the request's Authorization header.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password#2-reset-password-page
https://docs.medusajs.com/resources/storefront-development/customers/reset-password#2-reset-password-page
description: 'Storefront development: How to create the reset password page.'
x-authenticated: true
parameters:
www/apps/api-reference/specs/store/paths/auth_session.yaml
+1 -1
View File
@@ -7,7 +7,7 @@ post:
JWT token is required in the header of the request.
externalDocs:
url: >-
https://docs.medusajs.com/v2/storefront-development/customers/login#2-using-a-cookie-session
https://docs.medusajs.com/resources/storefront-development/customers/login#2-using-a-cookie-session
description: 'Storefront development: How to login as a customer'
x-authenticated: true
x-codeSamples:
www/apps/api-reference/specs/store/paths/auth_token_refresh.yaml
+1 -1
View File
@@ -8,7 +8,7 @@ post:
every day.
externalDocs:
url: >-
https://docs.medusajs.com/v2/storefront-development/customers/third-party-login
https://docs.medusajs.com/resources/storefront-development/customers/third-party-login
description: 'Storefront development: Implement third-party (social) login.'
x-authenticated: true
x-codeSamples:
www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml
+2 -2
View File
@@ -5,7 +5,7 @@ post:
x-authenticated: false
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/complete-cart
https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart
description: 'Storefront guide: How to implement cart completion during checkout.'
parameters:
- name: id
@@ -110,7 +110,7 @@ post:
title: type
description: >
The error's type. Can be a [MedusaError
type](https://docs.medusajs.com/v2/advanced-development/api-routes/errors#medusaerror-types)
type](https://docs.medusajs.com/learn/fundamentals/api-routes/errors#medusaerror-types)
or `payment_authorization_error` or
`payment_requires_more_error` for payment-related
errors.
www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml
+1 -1
View File
@@ -5,7 +5,7 @@ post:
description: Add a product variant as a line item in the cart.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#add-product-variant-to-cart
https://docs.medusajs.com/resources/storefront-development/cart/manage-items#add-product-variant-to-cart
description: 'Storefront guide: How to add a product variant to the cart.'
x-authenticated: false
parameters:
www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml
+2 -2
View File
@@ -5,7 +5,7 @@ post:
description: Update a line item's details in the cart.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#update-line-item-in-cart
https://docs.medusajs.com/resources/storefront-development/cart/manage-items#update-line-item-in-cart
description: 'Storefront guide: How to update a cart''s line item.'
x-authenticated: false
parameters:
@@ -123,7 +123,7 @@ delete:
description: Remove a line item from a cart.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#remove-line-item-from-cart
https://docs.medusajs.com/resources/storefront-development/cart/manage-items#remove-line-item-from-cart
description: 'Storefront guide: How to remove line item from cart.'
x-authenticated: false
parameters:
www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml
+2 -2
View File
@@ -6,7 +6,7 @@ post:
x-authenticated: false
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-promotions#add-promotion-to-cart
https://docs.medusajs.com/resources/storefront-development/cart/manage-promotions#add-promotion-to-cart
description: 'Storefront guide: How to add a promotion to cart.'
parameters:
- name: id
@@ -81,7 +81,7 @@ delete:
x-authenticated: false
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-promotions#remove-promotion-from-cart
https://docs.medusajs.com/resources/storefront-development/cart/manage-promotions#remove-promotion-from-cart
description: 'Storefront guide: How to remove a promotion from cart.'
parameters:
- name: id
www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml
+1 -1
View File
@@ -7,7 +7,7 @@ post:
chooses their preferred shipping option.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping
https://docs.medusajs.com/resources/storefront-development/checkout/shipping
description: 'Storefront guide: How to implement shipping during checkout.'
x-authenticated: false
parameters:
www/apps/api-reference/specs/store/paths/store_collections.yaml
+1 -1
View File
@@ -7,7 +7,7 @@ get:
x-authenticated: false
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list
https://docs.medusajs.com/resources/storefront-development/products/collections/list
description: 'Storefront guide: How to retrieve a list of collections.'
parameters:
- name: x-publishable-api-key
www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml
+1 -1
View File
@@ -7,7 +7,7 @@ get:
x-authenticated: false
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/collections/retrieve
https://docs.medusajs.com/resources/storefront-development/products/collections/retrieve
description: 'Storefront guide: How to retrieve a collection.'
parameters:
- name: id
www/apps/api-reference/specs/store/paths/store_customers.yaml
+1 -1
View File
@@ -7,7 +7,7 @@ post:
request.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/register
https://docs.medusajs.com/resources/storefront-development/customers/register
description: 'Storefront guide: How to register a customer.'
x-authenticated: true
parameters:
www/apps/api-reference/specs/store/paths/store_customers_me.yaml
+2 -2
View File
@@ -8,7 +8,7 @@ get:
x-authenticated: true
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/retrieve
https://docs.medusajs.com/resources/storefront-development/customers/retrieve
description: 'Storefront guide: How to retrieve the logged-in customer.'
parameters:
- name: x-publishable-api-key
@@ -84,7 +84,7 @@ post:
description: Update the logged-in customer's details.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/profile
https://docs.medusajs.com/resources/storefront-development/customers/profile
description: 'Storefront guide: How to edit a customer''s profile.'
x-authenticated: true
parameters:
www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml
+2 -2
View File
@@ -9,7 +9,7 @@ get:
x-authenticated: true
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#list-customer-addresses
https://docs.medusajs.com/resources/storefront-development/customers/addresses#list-customer-addresses
description: 'Storefront guide: How to retrieve the logged-in customer''s addresses.'
parameters:
- name: x-publishable-api-key
@@ -169,7 +169,7 @@ post:
description: Create an address for the logged-in customer.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#add-customer-address
https://docs.medusajs.com/resources/storefront-development/customers/addresses#add-customer-address
description: 'Storefront guide: How to create an address for the logged-in customer.'
x-authenticated: true
parameters:
www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml
+2 -2
View File
@@ -88,7 +88,7 @@ post:
description: Update the logged-in customer's address.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#edit-an-address
https://docs.medusajs.com/resources/storefront-development/customers/addresses#edit-an-address
description: 'Storefront guide: How to update an address of the logged-in customer.'
x-authenticated: true
parameters:
@@ -182,7 +182,7 @@ delete:
x-authenticated: true
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#delete-customer-address
https://docs.medusajs.com/resources/storefront-development/customers/addresses#delete-customer-address
description: 'Storefront guide: How to delete a customer''s address.'
parameters:
- name: address_id
www/apps/api-reference/specs/store/paths/store_payment-collections.yaml
+1 -1
View File
@@ -6,7 +6,7 @@ post:
the payment collection holds the cart's payment sessions.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
https://docs.medusajs.com/resources/storefront-development/checkout/payment
description: 'Storefront guide: How to implement payment during checkout.'
x-authenticated: false
parameters:
www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml
+1 -1
View File
@@ -25,7 +25,7 @@ post:
user guide.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
https://docs.medusajs.com/resources/storefront-development/checkout/payment
description: 'Storefront guide: How to implement payment during checkout.'
x-authenticated: false
parameters:
www/apps/api-reference/specs/store/paths/store_payment-providers.yaml
+1 -1
View File
@@ -7,7 +7,7 @@ get:
x-authenticated: false
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
https://docs.medusajs.com/resources/storefront-development/checkout/payment
description: 'Storefront guide: How to implement payment during checkout.'
parameters:
- name: x-publishable-api-key
www/apps/api-reference/specs/store/paths/store_product-categories.yaml
+1 -1
View File
@@ -8,7 +8,7 @@ get:
x-authenticated: false
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list
https://docs.medusajs.com/resources/storefront-development/products/categories/list
description: 'Storefront guide: How to retrieve a list of product categories.'
parameters:
- name: x-publishable-api-key
www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml
+1 -1
View File
@@ -7,7 +7,7 @@ get:
x-authenticated: false
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/categories/retrieve
https://docs.medusajs.com/resources/storefront-development/products/categories/retrieve
description: 'Storefront guide: How to retrieve a product category.'
parameters:
- name: id
www/apps/api-reference/specs/store/paths/store_products.yaml
+3 -4
View File
@@ -6,8 +6,7 @@ get:
`id`. The products can also be sorted or paginated.
x-authenticated: false
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/price
url: https://docs.medusajs.com/resources/storefront-development/products/price
description: 'Storefront guide: How to retrieve a product variants'' prices.'
parameters:
- name: x-publishable-api-key
@@ -165,7 +164,7 @@ get:
description: Filter by a collection's ID to retrieve the products in it.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/collections/products
https://docs.medusajs.com/resources/storefront-development/products/collections/products
description: 'Storefront guide: Retrieve a collection''s products.'
items:
type: string
@@ -753,7 +752,7 @@ get:
required if you're retrieving product variant prices with taxes.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price
https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price
description: 'Storefront guide: How to show product variants'' prices with taxes.'
- name: province
in: query
www/apps/api-reference/specs/store/paths/store_products_{id}.yaml
+2 -3
View File
@@ -6,8 +6,7 @@ get:
select the fields that should be returned.
x-authenticated: false
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/price
url: https://docs.medusajs.com/resources/storefront-development/products/price
description: 'Storefront guide: How to retrieve a product variants'' prices.'
parameters:
- name: id
@@ -56,7 +55,7 @@ get:
required if you're retrieving product variant prices with taxes.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price
https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price
description: 'Storefront guide: How to show product variants'' prices with taxes.'
- name: country_code
in: query
www/apps/api-reference/specs/store/paths/store_regions.yaml
+1 -1
View File
@@ -6,7 +6,7 @@ get:
`id`. The regions can also be sorted or paginated.
x-authenticated: false
externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/regions/list
url: https://docs.medusajs.com/resources/storefront-development/regions/list
description: 'Storefront guide: How to retrieve a list of regions.'
parameters:
- name: x-publishable-api-key
www/apps/api-reference/specs/store/paths/store_shipping-options.yaml
+1 -1
View File
@@ -9,7 +9,7 @@ get:
The shipping options also be sorted or paginated.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping
https://docs.medusajs.com/resources/storefront-development/checkout/shipping
description: 'Storefront guide: How to implement shipping during checkout.'
x-authenticated: false
parameters: