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

docs-util: fix issue with creating StoreProductType OAS schema (#11180)

Browse Source
This commit is contained in:
Shahed Nasser
2025-01-27 17:33:46 +02:00
committed by GitHub
parent 4ccb489dbe
commit dd487f02e1
17 changed files with 204 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -35,7 +35,7 @@ properties:
items:
type: object
type:
type: object
$ref: ./StoreProductType.yaml
length:
type: number
title: length

35
www/apps/api-reference/specs/admin/components/schemas/StoreProductType.yaml Normal file
View File

@@ -0,0 +1,35 @@
type: object
description: The product type's details.
x-schemaName: StoreProductType
required:
- id
- value
- created_at
- updated_at
properties:
id:
type: string
title: id
description: The product type's ID.
metadata:
type: object
description: The product type's metadata, can hold custom key-value pairs.
created_at:
type: string
format: date-time
title: created_at
description: The date the product type was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the product type was updated.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The date the product type was deleted.
value:
type: string
title: value
description: The type's value.

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

@@ -23,4 +23,4 @@ properties:
type: array
description: The list of product types.
items:
$ref: ./StoreProduct.yaml
$ref: ./StoreProductType.yaml

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

@@ -5,4 +5,4 @@ required:
- product_type
properties:
product_type:
$ref: ./StoreProduct.yaml
$ref: ./StoreProductType.yaml

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

@@ -68679,7 +68679,7 @@ components:
items:
type: object
type:
type: object
$ref: '#/components/schemas/StoreProductType'
length:
type: number
title: length
@@ -69116,6 +69116,42 @@ components:
properties:
product_tag:
$ref: '#/components/schemas/StoreProductTag'
StoreProductType:
type: object
description: The product type's details.
x-schemaName: StoreProductType
required:
- id
- value
- created_at
- updated_at
properties:
id:
type: string
title: id
description: The product type's ID.
metadata:
type: object
description: The product type's metadata, can hold custom key-value pairs.
created_at:
type: string
format: date-time
title: created_at
description: The date the product type was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the product type was updated.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The date the product type was deleted.
value:
type: string
title: value
description: The type's value.
StoreProductTypeListResponse:
type: object
description: The paginated list of product types.
@@ -69142,7 +69178,7 @@ components:
type: array
description: The list of product types.
items:
$ref: '#/components/schemas/StoreProduct'
$ref: '#/components/schemas/StoreProductType'
StoreProductTypeResponse:
type: object
description: The product type's details.
@@ -69151,7 +69187,7 @@ components:
- product_type
properties:
product_type:
$ref: '#/components/schemas/StoreProduct'
$ref: '#/components/schemas/StoreProductType'
StoreProductVariant:
type: object
description: The variant's details.

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

@@ -35,7 +35,7 @@ properties:
items:
type: object
type:
type: object
$ref: ./StoreProductType.yaml
length:
type: number
title: length

35
www/apps/api-reference/specs/store/components/schemas/StoreProductType.yaml Normal file
View File

@@ -0,0 +1,35 @@
type: object
description: The product type's details.
x-schemaName: StoreProductType
required:
- id
- value
- created_at
- updated_at
properties:
id:
type: string
title: id
description: The product type's ID.
metadata:
type: object
description: The product type's metadata, can hold custom key-value pairs.
created_at:
type: string
format: date-time
title: created_at
description: The date the product type was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the product type was updated.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The date the product type was deleted.
value:
type: string
title: value
description: The type's value.

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

@@ -23,4 +23,4 @@ properties:
type: array
description: The list of product types.
items:
$ref: ./StoreProduct.yaml
$ref: ./StoreProductType.yaml

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

@@ -5,4 +5,4 @@ required:
- product_type
properties:
product_type:
$ref: ./StoreProduct.yaml
$ref: ./StoreProductType.yaml

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

@@ -101,6 +101,8 @@ tags:
x-associatedSchema:
$ref: '#/components/schemas/StoreProductTag'
- name: Product Types
x-associatedSchema:
$ref: '#/components/schemas/StoreProductType'
- name: Products
description: |
Customers browse products for their purchase.
@@ -32624,7 +32626,7 @@ components:
items:
type: object
type:
type: object
$ref: '#/components/schemas/StoreProductType'
length:
type: number
title: length
@@ -33061,6 +33063,42 @@ components:
properties:
product_tag:
$ref: '#/components/schemas/StoreProductTag'
StoreProductType:
type: object
description: The product type's details.
x-schemaName: StoreProductType
required:
- id
- value
- created_at
- updated_at
properties:
id:
type: string
title: id
description: The product type's ID.
metadata:
type: object
description: The product type's metadata, can hold custom key-value pairs.
created_at:
type: string
format: date-time
title: created_at
description: The date the product type was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the product type was updated.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The date the product type was deleted.
value:
type: string
title: value
description: The type's value.
StoreProductTypeListResponse:
type: object
description: The paginated list of product types.
@@ -33087,7 +33125,7 @@ components:
type: array
description: The list of product types.
items:
$ref: '#/components/schemas/StoreProduct'
$ref: '#/components/schemas/StoreProductType'
StoreProductTypeResponse:
type: object
description: The product type's details.
@@ -33096,7 +33134,7 @@ components:
- product_type
properties:
product_type:
$ref: '#/components/schemas/StoreProduct'
$ref: '#/components/schemas/StoreProductType'
StoreProductVariant:
type: object
description: The variant's details.

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

@@ -126,6 +126,8 @@ tags:
x-associatedSchema:
$ref: ./components/schemas/StoreProductTag.yaml
- name: Product Types
x-associatedSchema:
$ref: ./components/schemas/StoreProductType.yaml
- name: Products
description: >
Customers browse products for their purchase.

2
www/utils/generated/oas-output/base/store.oas.base.yaml
View File

@@ -111,6 +111,8 @@ tags:
x-associatedSchema:
$ref: "#/components/schemas/StoreProductTag"
- name: Product Types
x-associatedSchema:
$ref: "#/components/schemas/StoreProductType"
- name: Products
description: >
Customers browse products for their purchase.

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

@@ -37,7 +37,7 @@
* items:
* $ref: "#/components/schemas/StoreProductCategory"
* type:
* $ref: "#/components/schemas/StoreProduct"
* $ref: "#/components/schemas/StoreProductType"
* length:
* type: number
* title: length

40
www/utils/generated/oas-output/schemas/StoreProductType.ts Normal file
View File

@@ -0,0 +1,40 @@
/**
* @schema StoreProductType
* type: object
* description: The product type's details.
* x-schemaName: StoreProductType
* required:
* - id
* - value
* - created_at
* - updated_at
* properties:
* id:
* type: string
* title: id
* description: The product type's ID.
* metadata:
* type: object
* description: The product type's metadata, can hold custom key-value pairs.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the product type was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the product type was updated.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The date the product type was deleted.
* value:
* type: string
* title: value
* description: The type's value.
*
*/

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

@@ -25,7 +25,7 @@
* type: array
* description: The list of product types.
* items:
* $ref: "#/components/schemas/StoreProduct"
* $ref: "#/components/schemas/StoreProductType"
*
*/

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

@@ -7,7 +7,7 @@
* - product_type
* properties:
* product_type:
* $ref: "#/components/schemas/StoreProduct"
* $ref: "#/components/schemas/StoreProductType"
*
*/

2
www/utils/packages/docs-generator/src/classes/helpers/oas-schema.ts
View File

@@ -357,7 +357,7 @@ class OasSchemaHelper {
.replace("DTO", "")
.replace(this.schemaRefPrefix, "")
.replace(
/(?<!(AdminProduct|CreateProduct|StoreShippingOption|AdminShippingOption|CreateShippingOption|BaseProduct))Type$/,
/(?<!(AdminProduct|CreateProduct|StoreShippingOption|AdminShippingOption|CreateShippingOption|BaseProduct|StoreProduct))Type$/,
""
)
}