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

chore(docs): Updated API Reference (automated) (#11396)

Browse Source 
* chore(docs): Generated API Reference (automated)

* fixes

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2025-02-11 14:46:38 +02:00
committed by GitHub
parent 7ba178e2d6
commit 7897bead63
17 changed files with 70 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProduct.yaml
View File

@@ -155,5 +155,9 @@ properties:
type: string
title: id
description: The product's ID.
shipping_profile_id:
type: string
title: shipping_profile_id
description: The ID of the product's shipping profile.
required:
- id

5
www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml
View File

@@ -3,6 +3,7 @@ description: The product's details.
x-schemaName: AdminCreateProduct
required:
- title
- shipping_profile_id
- options
properties:
title:
@@ -150,3 +151,7 @@ properties:
type: string
title: external_id
description: The ID of the product in an external or third-party system.
shipping_profile_id:
type: string
title: shipping_profile_id
description: The ID of the product's shipping profile.

2
www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml
View File

@@ -166,3 +166,5 @@ properties:
format: date-time
title: deleted_at
description: The date the product was deleted.
shipping_profile:
$ref: ./AdminShippingProfile.yaml

3
www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml
View File

@@ -103,3 +103,6 @@ properties:
metadata:
type: object
description: The address's metadata, can hold custom key-value pairs.
metadata:
type: object
description: The order's metadata, can hold custom key-value pairs.

6
www/apps/api-reference/specs/admin/components/schemas/StoreInitializePaymentSession.yaml
View File

@@ -8,12 +8,6 @@ properties:
title: provider_id
description: The ID of the payment provider the customer chose.
example: pp_stripe_stripe
context:
type: object
description: >-
The payment's context, such as the customer or address details. If the
customer is logged-in, the customer `id` is set in the context under a
`customer.id` property.
data:
type: object
description: Any data necessary for the payment provider to process the payment.

17
www/apps/api-reference/specs/admin/openapi.full.yaml
View File

@@ -44212,6 +44212,10 @@ components:
type: string
title: id
description: The product's ID.
shipping_profile_id:
type: string
title: shipping_profile_id
description: The ID of the product's shipping profile.
required:
- id
AdminBatchUpdateProductVariant:
@@ -45103,6 +45107,7 @@ components:
x-schemaName: AdminCreateProduct
required:
- title
- shipping_profile_id
- options
properties:
title:
@@ -45250,6 +45255,10 @@ components:
type: string
title: external_id
description: The ID of the product in an external or third-party system.
shipping_profile_id:
type: string
title: shipping_profile_id
description: The ID of the product's shipping profile.
AdminCreateProductCategory:
type: object
description: The product category's details.
@@ -51343,6 +51352,8 @@ components:
format: date-time
title: deleted_at
description: The date the product was deleted.
shipping_profile:
$ref: '#/components/schemas/AdminShippingProfile'
AdminProductCategory:
type: object
description: The product category's details.
@@ -54160,6 +54171,9 @@ components:
metadata:
type: object
description: The address's metadata, can hold custom key-value pairs.
metadata:
type: object
description: The order's metadata, can hold custom key-value pairs.
AdminUpdatePriceList:
type: object
description: the details to update in a price list.
@@ -62343,9 +62357,6 @@ components:
title: provider_id
description: The ID of the payment provider the customer chose.
example: pp_stripe_stripe
context:
type: object
description: The payment's context, such as the customer or address details. If the customer is logged-in, the customer `id` is set in the context under a `customer.id` property.
data:
type: object
description: Any data necessary for the payment provider to process the payment.

4
www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProduct.yaml
View File

@@ -155,5 +155,9 @@ properties:
type: string
title: id
description: The product's ID.
shipping_profile_id:
type: string
title: shipping_profile_id
description: The ID of the product's shipping profile.
required:
- id

5
www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml
View File

@@ -3,6 +3,7 @@ description: The product's details.
x-schemaName: AdminCreateProduct
required:
- title
- shipping_profile_id
- options
properties:
title:
@@ -150,3 +151,7 @@ properties:
type: string
title: external_id
description: The ID of the product in an external or third-party system.
shipping_profile_id:
type: string
title: shipping_profile_id
description: The ID of the product's shipping profile.

2
www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml
View File

@@ -166,3 +166,5 @@ properties:
format: date-time
title: deleted_at
description: The date the product was deleted.
shipping_profile:
$ref: ./AdminShippingProfile.yaml

3
www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml
View File

@@ -103,3 +103,6 @@ properties:
metadata:
type: object
description: The address's metadata, can hold custom key-value pairs.
metadata:
type: object
description: The order's metadata, can hold custom key-value pairs.

6
www/apps/api-reference/specs/store/components/schemas/StoreInitializePaymentSession.yaml
View File

@@ -8,12 +8,6 @@ properties:
title: provider_id
description: The ID of the payment provider the customer chose.
example: pp_stripe_stripe
context:
type: object
description: >-
The payment's context, such as the customer or address details. If the
customer is logged-in, the customer `id` is set in the context under a
`customer.id` property.
data:
type: object
description: Any data necessary for the payment provider to process the payment.

17
www/apps/api-reference/specs/store/openapi.full.yaml
View File

@@ -8148,6 +8148,10 @@ components:
type: string
title: id
description: The product's ID.
shipping_profile_id:
type: string
title: shipping_profile_id
description: The ID of the product's shipping profile.
required:
- id
AdminBatchUpdateProductVariant:
@@ -9039,6 +9043,7 @@ components:
x-schemaName: AdminCreateProduct
required:
- title
- shipping_profile_id
- options
properties:
title:
@@ -9186,6 +9191,10 @@ components:
type: string
title: external_id
description: The ID of the product in an external or third-party system.
shipping_profile_id:
type: string
title: shipping_profile_id
description: The ID of the product's shipping profile.
AdminCreateProductCategory:
type: object
description: The product category's details.
@@ -15279,6 +15288,8 @@ components:
format: date-time
title: deleted_at
description: The date the product was deleted.
shipping_profile:
$ref: '#/components/schemas/AdminShippingProfile'
AdminProductCategory:
type: object
description: The product category's details.
@@ -18096,6 +18107,9 @@ components:
metadata:
type: object
description: The address's metadata, can hold custom key-value pairs.
metadata:
type: object
description: The order's metadata, can hold custom key-value pairs.
AdminUpdatePriceList:
type: object
description: the details to update in a price list.
@@ -26279,9 +26293,6 @@ components:
title: provider_id
description: The ID of the payment provider the customer chose.
example: pp_stripe_stripe
context:
type: object
description: The payment's context, such as the customer or address details. If the customer is logged-in, the customer `id` is set in the context under a `customer.id` property.
data:
type: object
description: Any data necessary for the payment provider to process the payment.

4
www/utils/generated/oas-output/schemas/AdminBatchUpdateProduct.ts
View File

@@ -155,6 +155,10 @@
* type: string
* title: id
* description: The product's ID.
* shipping_profile_id:
* type: string
* title: shipping_profile_id
* description: The ID of the product's shipping profile.
* required:
* - id
*

5
www/utils/generated/oas-output/schemas/AdminCreateProduct.ts
View File

@@ -5,6 +5,7 @@
* x-schemaName: AdminCreateProduct
* required:
* - title
* - shipping_profile_id
* - options
* properties:
* title:
@@ -152,6 +153,10 @@
* type: string
* title: external_id
* description: The ID of the product in an external or third-party system.
* shipping_profile_id:
* type: string
* title: shipping_profile_id
* description: The ID of the product's shipping profile.
*
*/

2
www/utils/generated/oas-output/schemas/AdminProduct.ts
View File

@@ -168,6 +168,8 @@
* format: date-time
* title: deleted_at
* description: The date the product was deleted.
* shipping_profile:
* $ref: "#/components/schemas/AdminShippingProfile"
*
*/

3
www/utils/generated/oas-output/schemas/AdminUpdateOrder.ts
View File

@@ -105,6 +105,9 @@
* metadata:
* type: object
* description: The address's metadata, can hold custom key-value pairs.
* metadata:
* type: object
* description: The order's metadata, can hold custom key-value pairs.
*
*/

3
www/utils/generated/oas-output/schemas/StoreInitializePaymentSession.ts
View File

@@ -10,9 +10,6 @@
* title: provider_id
* description: The ID of the payment provider the customer chose.
* example: pp_stripe_stripe
* context:
* type: object
* description: The payment's context, such as the customer or address details. If the customer is logged-in, the customer `id` is set in the context under a `customer.id` property.
* data:
* type: object
* description: Any data necessary for the payment provider to process the payment.