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

2025-01-27 17:33:46 +02:00
parent 4ccb489dbe
commit dd487f02e1
17 changed files with 204 additions and 16 deletions
@@ -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.
@@ -37,7 +37,7 @@
 *     items:
 *       $ref: "#/components/schemas/StoreProductCategory"
 *   type:
- *     $ref: "#/components/schemas/StoreProduct"
+ *     $ref: "#/components/schemas/StoreProductType"
 *   length:
 *     type: number
 *     title: length
@@ -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.
+ * 
+*/
+
@@ -25,7 +25,7 @@
 *     type: array
 *     description: The list of product types.
 *     items:
- *       $ref: "#/components/schemas/StoreProduct"
+ *       $ref: "#/components/schemas/StoreProductType"
 * 
 */

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