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

docs-util: add publishable api key header parameter to store routes OAS (#10747)

Browse Source 
* docs-util: add publishable api key header parameter to store routes OAS

* fix oas
This commit is contained in:
Shahed Nasser
2024-12-26 16:27:55 +02:00
committed by GitHub
parent b9e7090842
commit 91ebf6d61c
92 changed files with 1268 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/api-reference/specs/store/paths/store_carts.yaml
+8
View File
@@ -4,6 +4,14 @@ post:
description: Create a cart.
x-authenticated: false
parameters:
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml
+16
View File
@@ -12,6 +12,14 @@ get:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
@@ -70,6 +78,14 @@ post:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml
+8
View File
@@ -14,6 +14,14 @@ post:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_carts_{id}_customer.yaml
+8
View File
@@ -17,6 +17,14 @@ post:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml
+8
View File
@@ -15,6 +15,14 @@ post:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml
+16
View File
@@ -21,6 +21,14 @@ post:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
@@ -94,6 +102,14 @@ delete:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml
+16
View File
@@ -11,6 +11,14 @@ post:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
@@ -84,6 +92,14 @@ delete:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml
+8
View File
@@ -17,6 +17,14 @@ post:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml
+8
View File
@@ -11,6 +11,14 @@ post:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_collections.yaml
+8
View File
@@ -10,6 +10,14 @@ get:
https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list
description: 'Storefront guide: How to retrieve a list of collections.'
parameters:
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml
+8
View File
@@ -16,6 +16,14 @@ get:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_currencies.yaml
+8
View File
@@ -6,6 +6,14 @@ get:
as `code`. The currencies can also be sorted or paginated.
x-authenticated: false
parameters:
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_currencies_{code}.yaml
+8
View File
@@ -12,6 +12,14 @@ get:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_customers.yaml
+8
View File
@@ -11,6 +11,14 @@ post:
description: 'Storefront guide: How to register a customer.'
x-authenticated: true
parameters:
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_customers_me.yaml
+16
View File
@@ -11,6 +11,14 @@ get:
https://docs.medusajs.com/v2/resources/storefront-development/customers/retrieve
description: 'Storefront guide: How to retrieve the logged-in customer.'
parameters:
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
@@ -68,6 +76,14 @@ post:
description: 'Storefront guide: How to edit a customer''s profile.'
x-authenticated: true
parameters:
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml
+16
View File
@@ -12,6 +12,14 @@ get:
https://docs.medusajs.com/v2/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
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
@@ -156,6 +164,14 @@ post:
description: 'Storefront guide: How to create an address for the logged-in customer.'
x-authenticated: true
parameters:
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml
+24
View File
@@ -13,6 +13,14 @@ get:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
@@ -77,6 +85,14 @@ post:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
@@ -209,6 +225,14 @@ delete:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_orders.yaml
+8
View File
@@ -7,6 +7,14 @@ get:
fields such as `id`. The orders can also be sorted or paginated.
x-authenticated: true
parameters:
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml
+8
View File
@@ -12,6 +12,14 @@ get:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_accept.yaml
+8
View File
@@ -18,6 +18,14 @@ post:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_cancel.yaml
+8
View File
@@ -15,6 +15,14 @@ post:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_decline.yaml
+8
View File
@@ -14,6 +14,14 @@ post:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_request.yaml
+8
View File
@@ -15,6 +15,14 @@ post:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_payment-collections.yaml
+8
View File
@@ -10,6 +10,14 @@ post:
description: 'Storefront guide: How to implement payment during checkout.'
x-authenticated: false
parameters:
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml
+8
View File
@@ -19,6 +19,14 @@ post:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_payment-providers.yaml
+8
View File
@@ -10,6 +10,14 @@ get:
https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
description: 'Storefront guide: How to implement payment during checkout.'
parameters:
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_product-categories.yaml
+8
View File
@@ -11,6 +11,14 @@ get:
https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list
description: 'Storefront guide: How to retrieve a list of product categories.'
parameters:
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml
+8
View File
@@ -16,6 +16,14 @@ get:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_products.yaml
+8
View File
@@ -10,6 +10,14 @@ get:
https://docs.medusajs.com/v2/resources/storefront-development/products/price
description: 'Storefront guide: How to retrieve a product variants'' prices.'
parameters:
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_products_{id}.yaml
+43
View File
@@ -16,6 +16,14 @@ get:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
@@ -89,6 +97,41 @@ get:
The ID of the customer's cart. If set, the cart's region and shipping
address's country code and province are used instead of the
`region_id`, `country_code`, and `province` properties.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: order
in: query
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 `-`.
required: false
schema:
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'
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_regions.yaml
+8
View File
@@ -9,6 +9,14 @@ get:
url: https://docs.medusajs.com/v2/resources/storefront-development/regions/list
description: 'Storefront guide: How to retrieve a list of regions.'
parameters:
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml
+8
View File
@@ -12,6 +12,14 @@ get:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_return-reasons.yaml
+8
View File
@@ -6,6 +6,14 @@ get:
paginated.
x-authenticated: false
parameters:
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml
+8
View File
@@ -12,6 +12,14 @@ get:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_return.yaml
+9
View File
@@ -37,3 +37,12 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createAndCompleteReturnOrderWorkflow
parameters:
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
www/apps/api-reference/specs/store/paths/store_shipping-options.yaml
+8
View File
@@ -13,6 +13,14 @@ get:
description: 'Storefront guide: How to implement shipping during checkout.'
x-authenticated: false
parameters:
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_shipping-options_{id}_calculate.yaml
+8
View File
@@ -10,6 +10,14 @@ post:
required: true
schema:
type: string
- name: x-publishable-api-key
in: header
description: Publishable API Key created in the Medusa Admin.
required: true
schema:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-