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

docs: fix to OAS generator following Zod update + generate API reference (#13030)

Browse Source
This commit is contained in:
Shahed Nasser
2025-07-24 14:36:28 +03:00
committed by GitHub
parent 3921c86e19
commit 9bb4c0306b
126 changed files with 4855 additions and 2689 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml
View File

@@ -47,24 +47,7 @@ post:
content:
application/json:
schema:
type: object
description: The shipping method's details.
required:
- option_id
properties:
option_id:
type: string
title: option_id
description: The ID of the shipping option this method is created from.
data:
type: object
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.
$ref: ../components/schemas/StoreAddCartShippingMethods.yaml
x-codeSamples:
- lang: JavaScript
label: JS SDK

67
www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml
View File

@@ -225,72 +225,7 @@ post:
content:
application/json:
schema:
type: object
description: The address's details.
properties:
first_name:
type: string
title: first_name
description: The customer's first name.
last_name:
type: string
title: last_name
description: The customer's last name.
phone:
type: string
title: phone
description: The customer's phone.
company:
type: string
title: company
description: The address's company.
address_1:
type: string
title: address_1
description: The address's first line.
address_2:
type: string
title: address_2
description: The address's second line.
city:
type: string
title: city
description: The address's city.
country_code:
type: string
title: country_code
description: The address's country code.
province:
type: string
title: province
description: The address's ISO 3166-2 province code. Must be lower-case.
example: us-ca
externalDocs:
url: https://en.wikipedia.org/wiki/ISO_3166-2
description: Learn more about ISO 3166-2
postal_code:
type: string
title: postal_code
description: The address's postal code.
address_name:
type: string
title: address_name
description: The address's name.
is_default_shipping:
type: boolean
title: is_default_shipping
description: >-
Whether the address is used by default for shipping during
checkout.
is_default_billing:
type: boolean
title: is_default_billing
description: >-
Whether the address is used by default for billing during
checkout.
metadata:
type: object
description: Holds custom key-value pairs.
$ref: ../components/schemas/StoreCreateCustomerAddress.yaml
x-codeSamples:
- lang: JavaScript
label: JS SDK

67
www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml
View File

@@ -139,72 +139,7 @@ post:
content:
application/json:
schema:
type: object
description: The properties to update in the address.
properties:
first_name:
type: string
title: first_name
description: The customer's first name.
last_name:
type: string
title: last_name
description: The customer's last name.
phone:
type: string
title: phone
description: The customer's phone.
company:
type: string
title: company
description: The address's company.
address_1:
type: string
title: address_1
description: The address's first line.
address_2:
type: string
title: address_2
description: The address's second line.
city:
type: string
title: city
description: The address's city.
country_code:
type: string
title: country_code
description: The address's country code.
province:
type: string
title: province
description: The address's ISO 3166-2 province code. Must be lower-case.
example: us-ca
externalDocs:
url: https://en.wikipedia.org/wiki/ISO_3166-2
description: Learn more about ISO 3166-2
postal_code:
type: string
title: postal_code
description: The address's postal code.
address_name:
type: string
title: address_name
description: The address's name.
is_default_shipping:
type: boolean
title: is_default_shipping
description: >-
Whether the address is used by default for shipping during
checkout.
is_default_billing:
type: boolean
title: is_default_billing
description: >-
Whether the address is used by default for billing during
checkout.
metadata:
type: object
description: Holds custom key-value pairs.
$ref: ../components/schemas/StoreUpdateCustomerAddress.yaml
x-codeSamples:
- lang: JavaScript
label: JS SDK