asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 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 authored and GitHub committed 2025-07-24 14:36:28 +03:00
1 parent 3921c86e19
commit 9bb4c0306b
126 files changed
+4855 -2689
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts
+1 -15
View File
@@ -39,21 +39,7 @@
* 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"
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts
+1 -62
View File
@@ -38,68 +38,7 @@
* 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"
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts
+1 -62
View File
@@ -44,68 +44,7 @@
* 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"
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts
+4 -6
View File
@@ -4,14 +4,12 @@
* summary: Initialize Payment Session of a Payment Collection
* x-sidebar-summary: Initialize Payment Session
* description: >
* Initialize and add a payment session to a payment collection. This is used during checkout, where you create a payment collection for the cart, then initialize a payment session for the
* payment provider that the customer chooses.
* Initialize and add a payment session to a payment collection. This is used during checkout, where you create a payment collection for the cart, then initialize a payment session for the payment
* provider that the customer chooses.
*
* It's highly recommended to have an amount greater than `0` in the payment collection, as some payment providers, such as Stripe, require a non-zero amount to create a payment session. Otherwise,
* an error will be thrown on the payment provider's side.
* It's highly recommended to have an amount greater than `0` in the payment collection, as some payment providers, such as Stripe, require a non-zero amount to create a payment session. Otherwise, an error will be thrown on the payment provider's side.
*
* In cases where you want to create a payment session for a payment collection with an amount of `0`, you can use the Manual System Payment Provider instead of third-party payment providers.
* The Manual System Payment Provider is built into Medusa and allows you to create payment sessions without interacting with an external payment provider.
* In cases where you want to create a payment session for a payment collection with an amount of `0`, you can use the Manual System Payment Provider instead of third-party payment providers. The Manual System Payment Provider is built into Medusa and allows you to create payment sessions without interacting with an external payment provider.
*
* Make sure to configure the Manual System Payment Provider in your store's region. Learn more in the [Manage Region](https://docs.medusajs.com/user-guide/settings/regions#edit-region-details) user guide.
* externalDocs: