chore(docs): Updated API Reference (automated) (medusajs#10017)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <[email protected]> Co-authored-by: Shahed Nasser <[email protected]>
docloulou · Nov 11, 2024 · 82fd93d · 82fd93d
1 parent bc2d556
commit 82fd93d
Show file tree

Hide file tree

Showing 28 changed files with 60 additions and 167 deletions.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml
@@ -215,4 +215,4 @@ properties:
   product_type_id:
     type: string
     title: product_type_id
-    description: The item's product type id.
+    description: The ID of the associated product's type.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml
@@ -215,4 +215,4 @@ properties:
   product_type_id:
     type: string
     title: product_type_id
-    description: The item's product type id.
+    description: The ID of the associated product's type.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml
@@ -210,4 +210,4 @@ properties:
   display_id:
     type: number
     title: display_id
-    description: The order's display id.
+    description: The order's display ID.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml
@@ -23,19 +23,8 @@ properties:
     title: no_notification
     description: Whether to send the customer notifications when the exchange is updated.
   difference_due:
-    oneOf:
-      - type: string
-        title: difference_due
-        description: The exchange's difference due.
-      - type: number
-        title: difference_due
-        description: The exchange's difference due.
-      - type: string
-        title: difference_due
-        description: The exchange's difference due.
-      - type: number
-        title: difference_due
-        description: The exchange's difference due.
+    type: number
+    title: difference_due
     description: >-
       The amount to be exchanged or refunded. If the amount is negative, it must
       be refunded. If positive, additional payment is required from the

diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml
@@ -197,4 +197,4 @@ properties:
   product_type_id:
     type: string
     title: product_type_id
-    description: The item's product type id.
+    description: The ID of the associated product's type.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Return.yaml b/www/apps/api-reference/specs/admin/components/schemas/Return.yaml
@@ -22,19 +22,8 @@ properties:
       - received
       - partially_received
   refund_amount:
-    oneOf:
-      - type: string
-        title: refund_amount
-        description: The return order's refund amount.
-      - type: number
-        title: refund_amount
-        description: The return order's refund amount.
-      - type: string
-        title: refund_amount
-        description: The return order's refund amount.
-      - type: number
-        title: refund_amount
-        description: The return order's refund amount.
+    type: number
+    title: refund_amount
     description: The amount refunded by this return.
   order_id:
     type: string

diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderLineItem.yaml
@@ -4013,4 +4013,4 @@ properties:
   product_type_id:
     type: string
     title: product_type_id
-    description: The item's product type id.
+    description: The ID of the associated product's type.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml
@@ -20,4 +20,4 @@ properties:
     description: The customer's phone.
   metadata:
     type: object
-    description: The customer's metadata.
+    description: The customer'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
@@ -11441,8 +11441,8 @@ paths:
           in: query
           description: |-
             Comma-separated fields that should be included in the returned data.
-             * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
-             * without prefix it will replace the entire default fields.
+            if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+            without prefix it will replace the entire default fields.
           required: false
           schema:
             type: string
@@ -48352,7 +48352,7 @@ components:
         product_type_id:
           type: string
           title: product_type_id
-          description: The item's product type id.
+          description: The ID of the associated product's type.
     AdminOrderPreview:
       type: object
       description: A preview of an order if a change, such as exchange, return, edit, or claim is applied on it.
@@ -55950,7 +55950,7 @@ components:
         product_type_id:
           type: string
           title: product_type_id
-          description: The item's product type id.
+          description: The ID of the associated product's type.
     BaseOrderLineItemAdjustment:
       type: object
       description: The adjustment's details.
@@ -58344,7 +58344,7 @@ components:
         display_id:
           type: number
           title: display_id
-          description: The order's display id.
+          description: The order's display ID.
     OrderAddress:
       type: object
       description: The address's details.
@@ -58807,19 +58807,8 @@ components:
           title: no_notification
           description: Whether to send the customer notifications when the exchange is updated.
         difference_due:
-          oneOf:
-            - type: string
-              title: difference_due
-              description: The exchange's difference due.
-            - type: number
-              title: difference_due
-              description: The exchange's difference due.
-            - type: string
-              title: difference_due
-              description: The exchange's difference due.
-            - type: number
-              title: difference_due
-              description: The exchange's difference due.
+          type: number
+          title: difference_due
           description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer.
         return:
           $ref: '#/components/schemas/Return'
@@ -59171,7 +59160,7 @@ components:
         product_type_id:
           type: string
           title: product_type_id
-          description: The item's product type id.
+          description: The ID of the associated product's type.
     OrderLineItemAdjustment:
       type: object
       description: The line item adjustment's details.
@@ -59702,19 +59691,8 @@ components:
             - received
             - partially_received
         refund_amount:
-          oneOf:
-            - type: string
-              title: refund_amount
-              description: The return order's refund amount.
-            - type: number
-              title: refund_amount
-              description: The return order's refund amount.
-            - type: string
-              title: refund_amount
-              description: The return order's refund amount.
-            - type: number
-              title: refund_amount
-              description: The return order's refund amount.
+          type: number
+          title: refund_amount
           description: The amount refunded by this return.
         order_id:
           type: string
@@ -65691,7 +65669,7 @@ components:
         product_type_id:
           type: string
           title: product_type_id
-          description: The item's product type id.
+          description: The ID of the associated product's type.
     StoreOrderResponse:
       type: object
       description: The order's details.
@@ -68561,7 +68539,7 @@ components:
           description: The customer's phone.
         metadata:
           type: object
-          description: The customer's metadata.
+          description: The customer's metadata, can hold custom key-value pairs.
     UpdateAddress:
       type: object
       description: The details to update in the address.

diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml
@@ -12,10 +12,13 @@ post:
         type: string
     - name: fields
       in: query
-      description: |-
+      description: >-
         Comma-separated fields that should be included in the returned data.
-         * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
-         * without prefix it will replace the entire default fields.
+
+        if a field is prefixed with `+` it will be added to the default fields,
+        using `-` will remove it from the default fields.
+
+        without prefix it will replace the entire default fields.
       required: false
       schema:
         type: string

diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml
@@ -215,4 +215,4 @@ properties:
   product_type_id:
     type: string
     title: product_type_id
-    description: The item's product type id.
+    description: The ID of the associated product's type.
diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml
@@ -215,4 +215,4 @@ properties:
   product_type_id:
     type: string
     title: product_type_id
-    description: The item's product type id.
+    description: The ID of the associated product's type.
diff --git a/www/apps/api-reference/specs/store/components/schemas/Order.yaml b/www/apps/api-reference/specs/store/components/schemas/Order.yaml
@@ -210,4 +210,4 @@ properties:
   display_id:
     type: number
     title: display_id
-    description: The order's display id.
+    description: The order's display ID.
diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml
@@ -23,19 +23,8 @@ properties:
     title: no_notification
     description: Whether to send the customer notifications when the exchange is updated.
   difference_due:
-    oneOf:
-      - type: string
-        title: difference_due
-        description: The exchange's difference due.
-      - type: number
-        title: difference_due
-        description: The exchange's difference due.
-      - type: string
-        title: difference_due
-        description: The exchange's difference due.
-      - type: number
-        title: difference_due
-        description: The exchange's difference due.
+    type: number
+    title: difference_due
     description: >-
       The amount to be exchanged or refunded. If the amount is negative, it must
       be refunded. If positive, additional payment is required from the

diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml
@@ -197,4 +197,4 @@ properties:
   product_type_id:
     type: string
     title: product_type_id
-    description: The item's product type id.
+    description: The ID of the associated product's type.
diff --git a/www/apps/api-reference/specs/store/components/schemas/Return.yaml b/www/apps/api-reference/specs/store/components/schemas/Return.yaml
@@ -22,19 +22,8 @@ properties:
       - received
       - partially_received
   refund_amount:
-    oneOf:
-      - type: string
-        title: refund_amount
-        description: The return order's refund amount.
-      - type: number
-        title: refund_amount
-        description: The return order's refund amount.
-      - type: string
-        title: refund_amount
-        description: The return order's refund amount.
-      - type: number
-        title: refund_amount
-        description: The return order's refund amount.
+    type: number
+    title: refund_amount
     description: The amount refunded by this return.
   order_id:
     type: string

diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrderLineItem.yaml
@@ -4013,4 +4013,4 @@ properties:
   product_type_id:
     type: string
     title: product_type_id
-    description: The item's product type id.
+    description: The ID of the associated product's type.
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml
@@ -20,4 +20,4 @@ properties:
     description: The customer's phone.
   metadata:
     type: object
-    description: The customer's metadata.
+    description: The customer'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
@@ -10382,7 +10382,7 @@ components:
         product_type_id:
           type: string
           title: product_type_id
-          description: The item's product type id.
+          description: The ID of the associated product's type.
     AdminOrderPreview:
       type: object
       description: A preview of an order if a change, such as exchange, return, edit, or claim is applied on it.
@@ -17980,7 +17980,7 @@ components:
         product_type_id:
           type: string
           title: product_type_id
-          description: The item's product type id.
+          description: The ID of the associated product's type.
     BaseOrderLineItemAdjustment:
       type: object
       description: The adjustment's details.
@@ -20374,7 +20374,7 @@ components:
         display_id:
           type: number
           title: display_id
-          description: The order's display id.
+          description: The order's display ID.
     OrderAddress:
       type: object
       description: The address's details.
@@ -20837,19 +20837,8 @@ components:
           title: no_notification
           description: Whether to send the customer notifications when the exchange is updated.
         difference_due:
-          oneOf:
-            - type: string
-              title: difference_due
-              description: The exchange's difference due.
-            - type: number
-              title: difference_due
-              description: The exchange's difference due.
-            - type: string
-              title: difference_due
-              description: The exchange's difference due.
-            - type: number
-              title: difference_due
-              description: The exchange's difference due.
+          type: number
+          title: difference_due
           description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer.
         return:
           $ref: '#/components/schemas/Return'
@@ -21201,7 +21190,7 @@ components:
         product_type_id:
           type: string
           title: product_type_id
-          description: The item's product type id.
+          description: The ID of the associated product's type.
     OrderLineItemAdjustment:
       type: object
       description: The line item adjustment's details.
@@ -21732,19 +21721,8 @@ components:
             - received
             - partially_received
         refund_amount:
-          oneOf:
-            - type: string
-              title: refund_amount
-              description: The return order's refund amount.
-            - type: number
-              title: refund_amount
-              description: The return order's refund amount.
-            - type: string
-              title: refund_amount
-              description: The return order's refund amount.
-            - type: number
-              title: refund_amount
-              description: The return order's refund amount.
+          type: number
+          title: refund_amount
           description: The amount refunded by this return.
         order_id:
           type: string
@@ -27721,7 +27699,7 @@ components:
         product_type_id:
           type: string
           title: product_type_id
-          description: The item's product type id.
+          description: The ID of the associated product's type.
     StoreOrderResponse:
       type: object
       description: The order's details.
@@ -30591,7 +30569,7 @@ components:
           description: The customer's phone.
         metadata:
           type: object
-          description: The customer's metadata.
+          description: The customer's metadata, can hold custom key-value pairs.
     UpdateAddress:
       type: object
       description: The details to update in the address.

diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts
@@ -15,8 +15,8 @@
  *     in: query
  *     description: |-
  *       Comma-separated fields that should be included in the returned data.
- *        * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
- *        * without prefix it will replace the entire default fields.
+ *       if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *       without prefix it will replace the entire default fields.
  *     required: false
  *     schema:
  *       type: string