fixes

medusajs · Feb 11, 2025 · 0f80119 · 0f80119
1 parent 80956d8
commit 0f80119
Show file tree

Hide file tree

Showing 14 changed files with 67 additions and 103 deletions.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProduct.yaml
@@ -158,6 +158,6 @@ properties:
   shipping_profile_id:
     type: string
     title: shipping_profile_id
-    description: The update's shipping profile id.
+    description: The ID of the product's shipping profile.
 required:
   - id
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml
@@ -154,4 +154,4 @@ properties:
   shipping_profile_id:
     type: string
     title: shipping_profile_id
-    description: The create's shipping profile id.
+    description: The ID of the product's shipping profile.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionRule.yaml
@@ -1,5 +1,5 @@
 type: object
-description: The rule's rules.
+description: The shipping option rule's details.
 x-schemaName: AdminShippingOptionRule
 required:
   - id
@@ -14,11 +14,12 @@ properties:
   id:
     type: string
     title: id
-    description: The rule's ID.
+    description: The shipping option rule's ID.
   attribute:
     type: string
     title: attribute
-    description: The rule's attribute.
+    description: The shipping option rule's attribute.
+    example: is_return
   operator:
     type: string
     description: The rule's operator.
@@ -32,32 +33,24 @@ properties:
       - gte
       - nin
   value:
-    oneOf:
-      - type: string
-        title: value
-        description: The rule's value.
-      - type: array
-        description: The rule's value.
-        items:
-          type: string
-          title: value
-          description: The value's details.
+    type: string
+    title: value
   shipping_option_id:
     type: string
     title: shipping_option_id
-    description: The rule's shipping option id.
+    description: The ID of the shipping option this rule is for.
   created_at:
     type: string
     format: date-time
     title: created_at
-    description: The rule's created at.
+    description: The date the shipping option rule was created.
   updated_at:
     type: string
     format: date-time
     title: updated_at
-    description: The rule's updated at.
+    description: The date the shipping option rule was updated.
   deleted_at:
     type: string
     format: date-time
     title: deleted_at
-    description: The rule's deleted at.
+    description: The date the shipping option rule was deleted.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml
@@ -105,4 +105,4 @@ properties:
         description: The address's metadata, can hold custom key-value pairs.
   metadata:
     type: object
-    description: The order's metadata.
+    description: The order's metadata, can hold custom key-value pairs.
diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml
@@ -44215,7 +44215,7 @@ components:
         shipping_profile_id:
           type: string
           title: shipping_profile_id
-          description: The update's shipping profile id.
+          description: The ID of the product's shipping profile.
       required:
         - id
     AdminBatchUpdateProductVariant:
@@ -45258,7 +45258,7 @@ components:
         shipping_profile_id:
           type: string
           title: shipping_profile_id
-          description: The create's shipping profile id.
+          description: The ID of the product's shipping profile.
     AdminCreateProductCategory:
       type: object
       description: The product category's details.
@@ -53315,7 +53315,7 @@ components:
           $ref: '#/components/schemas/AdminShippingOption'
     AdminShippingOptionRule:
       type: object
-      description: The rule's rules.
+      description: The shipping option rule's details.
       x-schemaName: AdminShippingOptionRule
       required:
         - id
@@ -53330,11 +53330,12 @@ components:
         id:
           type: string
           title: id
-          description: The rule's ID.
+          description: The shipping option rule's ID.
         attribute:
           type: string
           title: attribute
-          description: The rule's attribute.
+          description: The shipping option rule's attribute.
+          example: is_return
         operator:
           type: string
           description: The rule's operator.
@@ -53348,35 +53349,27 @@ components:
             - gte
             - nin
         value:
-          oneOf:
-            - type: string
-              title: value
-              description: The rule's value.
-            - type: array
-              description: The rule's value.
-              items:
-                type: string
-                title: value
-                description: The value's details.
+          type: string
+          title: value
         shipping_option_id:
           type: string
           title: shipping_option_id
-          description: The rule's shipping option id.
+          description: The ID of the shipping option this rule is for.
         created_at:
           type: string
           format: date-time
           title: created_at
-          description: The rule's created at.
+          description: The date the shipping option rule was created.
         updated_at:
           type: string
           format: date-time
           title: updated_at
-          description: The rule's updated at.
+          description: The date the shipping option rule was updated.
         deleted_at:
           type: string
           format: date-time
           title: deleted_at
-          description: The rule's deleted at.
+          description: The date the shipping option rule was deleted.
     AdminShippingOptionType:
       type: object
       description: The shipping option's details.
@@ -54180,7 +54173,7 @@ components:
               description: The address's metadata, can hold custom key-value pairs.
         metadata:
           type: object
-          description: The order's metadata.
+          description: The order's metadata, can hold custom key-value pairs.
     AdminUpdatePriceList:
       type: object
       description: the details to update in a price list.

diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProduct.yaml
@@ -158,6 +158,6 @@ properties:
   shipping_profile_id:
     type: string
     title: shipping_profile_id
-    description: The update's shipping profile id.
+    description: The ID of the product's shipping profile.
 required:
   - id
diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml
@@ -154,4 +154,4 @@ properties:
   shipping_profile_id:
     type: string
     title: shipping_profile_id
-    description: The create's shipping profile id.
+    description: The ID of the product's shipping profile.
diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionRule.yaml
@@ -1,5 +1,5 @@
 type: object
-description: The rule's rules.
+description: The shipping option rule's details.
 x-schemaName: AdminShippingOptionRule
 required:
   - id
@@ -14,11 +14,12 @@ properties:
   id:
     type: string
     title: id
-    description: The rule's ID.
+    description: The shipping option rule's ID.
   attribute:
     type: string
     title: attribute
-    description: The rule's attribute.
+    description: The shipping option rule's attribute.
+    example: is_return
   operator:
     type: string
     description: The rule's operator.
@@ -32,32 +33,24 @@ properties:
       - gte
       - nin
   value:
-    oneOf:
-      - type: string
-        title: value
-        description: The rule's value.
-      - type: array
-        description: The rule's value.
-        items:
-          type: string
-          title: value
-          description: The value's details.
+    type: string
+    title: value
   shipping_option_id:
     type: string
     title: shipping_option_id
-    description: The rule's shipping option id.
+    description: The ID of the shipping option this rule is for.
   created_at:
     type: string
     format: date-time
     title: created_at
-    description: The rule's created at.
+    description: The date the shipping option rule was created.
   updated_at:
     type: string
     format: date-time
     title: updated_at
-    description: The rule's updated at.
+    description: The date the shipping option rule was updated.
   deleted_at:
     type: string
     format: date-time
     title: deleted_at
-    description: The rule's deleted at.
+    description: The date the shipping option rule was deleted.
diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml
@@ -105,4 +105,4 @@ properties:
         description: The address's metadata, can hold custom key-value pairs.
   metadata:
     type: object
-    description: The order's metadata.
+    description: The order's metadata, can hold custom key-value pairs.
diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml
@@ -8151,7 +8151,7 @@ components:
         shipping_profile_id:
           type: string
           title: shipping_profile_id
-          description: The update's shipping profile id.
+          description: The ID of the product's shipping profile.
       required:
         - id
     AdminBatchUpdateProductVariant:
@@ -9194,7 +9194,7 @@ components:
         shipping_profile_id:
           type: string
           title: shipping_profile_id
-          description: The create's shipping profile id.
+          description: The ID of the product's shipping profile.
     AdminCreateProductCategory:
       type: object
       description: The product category's details.
@@ -17251,7 +17251,7 @@ components:
           $ref: '#/components/schemas/AdminShippingOption'
     AdminShippingOptionRule:
       type: object
-      description: The rule's rules.
+      description: The shipping option rule's details.
       x-schemaName: AdminShippingOptionRule
       required:
         - id
@@ -17266,11 +17266,12 @@ components:
         id:
           type: string
           title: id
-          description: The rule's ID.
+          description: The shipping option rule's ID.
         attribute:
           type: string
           title: attribute
-          description: The rule's attribute.
+          description: The shipping option rule's attribute.
+          example: is_return
         operator:
           type: string
           description: The rule's operator.
@@ -17284,35 +17285,27 @@ components:
             - gte
             - nin
         value:
-          oneOf:
-            - type: string
-              title: value
-              description: The rule's value.
-            - type: array
-              description: The rule's value.
-              items:
-                type: string
-                title: value
-                description: The value's details.
+          type: string
+          title: value
         shipping_option_id:
           type: string
           title: shipping_option_id
-          description: The rule's shipping option id.
+          description: The ID of the shipping option this rule is for.
         created_at:
           type: string
           format: date-time
           title: created_at
-          description: The rule's created at.
+          description: The date the shipping option rule was created.
         updated_at:
           type: string
           format: date-time
           title: updated_at
-          description: The rule's updated at.
+          description: The date the shipping option rule was updated.
         deleted_at:
           type: string
           format: date-time
           title: deleted_at
-          description: The rule's deleted at.
+          description: The date the shipping option rule was deleted.
     AdminShippingOptionType:
       type: object
       description: The shipping option's details.
@@ -18116,7 +18109,7 @@ components:
               description: The address's metadata, can hold custom key-value pairs.
         metadata:
           type: object
-          description: The order's metadata.
+          description: The order's metadata, can hold custom key-value pairs.
     AdminUpdatePriceList:
       type: object
       description: the details to update in a price list.

diff --git a/www/utils/generated/oas-output/schemas/AdminBatchUpdateProduct.ts b/www/utils/generated/oas-output/schemas/AdminBatchUpdateProduct.ts
@@ -158,7 +158,7 @@
  *   shipping_profile_id:
  *     type: string
  *     title: shipping_profile_id
- *     description: The update's shipping profile id.
+ *     description: The ID of the product's shipping profile.
  * required:
  *   - id
  * 

diff --git a/www/utils/generated/oas-output/schemas/AdminCreateProduct.ts b/www/utils/generated/oas-output/schemas/AdminCreateProduct.ts
@@ -156,7 +156,7 @@
  *   shipping_profile_id:
  *     type: string
  *     title: shipping_profile_id
- *     description: The create's shipping profile id.
+ *     description: The ID of the product's shipping profile.
  * 
 */