chore(docs): Generated API Reference (v2)

www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml

@@ -79,7 +79,11 @@ properties:
     title: updated_at
     description: The claim's update date.
   order:
-    $ref: ./AdminOrder.yaml
+    type: string
+    title: order
+    description: The order's details.
+    externalDocs:
+      url: '#pagination'
   type:
     type: string
     description: The claim's type.

www/apps/api-reference/specs/admin/components/schemas/AdminClaimOrderResponse.yaml

@@ -6,6 +6,10 @@ required:
   - claim
 properties:
   order:
-    $ref: ./Order.yaml
+    type: string
+    title: order
+    description: The order change's order.
+    externalDocs:
+      url: '#pagination'
   claim:
     $ref: ./AdminClaim.yaml

www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml

@@ -1,5 +1,5 @@
 type: object
-description: The shipping option's details.
+description: The shipping option's type.
 x-schemaName: AdminCreateShippingOption
 required:
   - label

www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOptionRule.yaml

@@ -1,5 +1,5 @@
 type: object
-description: The details of the shipping option rule.
+description: The rule's rules.
 x-schemaName: AdminCreateShippingOptionRule
 required:
   - operator
@@ -8,7 +8,7 @@ required:
 properties:
   operator:
     type: string
-    description: The operator used to check whether a rule applies.
+    description: The rule's operator.
     enum:
       - gt
       - lt
@@ -21,18 +21,15 @@ properties:
   attribute:
     type: string
     title: attribute
-    description: The name of a property or table that the rule applies to.
-    example: customer_group
+    description: The rule's attribute.
   value:
     oneOf:
       - type: string
         title: value
-        description: A value of the attribute that enables this rule.
-        example: cusgroup_123
+        description: The rule's value.
       - type: array
-        description: Values of the attribute that enable this rule.
+        description: The rule's value.
         items:
           type: string
           title: value
-          description: A value of the attribute that enables this rule.
-          example: cusgroup_123
+          description: The value's details.

www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml

@@ -95,7 +95,11 @@ properties:
     title: deleted_at
     description: The date the exchange was deleted.
   order:
-    $ref: ./AdminOrder.yaml
+    type: string
+    title: order
+    description: The order's details.
+    externalDocs:
+      url: '#pagination'
   allow_backorder:
     type: boolean
     title: allow_backorder

www/apps/api-reference/specs/admin/components/schemas/AdminExchangeOrderResponse.yaml

@@ -6,7 +6,10 @@ required:
   - exchange
 properties:
   order:
-    description: The details of the associated order.
-    $ref: ./Order.yaml
+    type: string
+    title: order
+    description: The order change's order.
+    externalDocs:
+      url: '#pagination'
   exchange:
     $ref: ./AdminExchange.yaml

www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreviewResponse.yaml

@@ -5,4 +5,10 @@ required:
   - order
 properties:
   order:
-    $ref: ./AdminOrderPreview.yaml
+    type: string
+    title: order
+    description: >-
+      A preview of an order if a change, such as exchange, return, edit, or
+      claim is applied on it.
+    externalDocs:
+      url: '#pagination'

www/apps/api-reference/specs/admin/components/schemas/AdminOrderResponse.yaml

@@ -5,4 +5,8 @@ required:
   - order
 properties:
   order:
-    $ref: ./AdminOrder.yaml
+    type: string
+    title: order
+    description: The order's details.
+    externalDocs:
+      url: '#pagination'

www/apps/api-reference/specs/admin/components/schemas/AdminOrderReturnResponse.yaml

@@ -6,6 +6,10 @@ required:
   - return
 properties:
   order:
-    $ref: ./Order.yaml
+    type: string
+    title: order
+    description: The order change's order.
+    externalDocs:
+      url: '#pagination'
   return:
     $ref: ./AdminReturn.yaml

www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml

@@ -10,3 +10,7 @@ properties:
     type: string
     title: internal_note
     description: A note viewed only by admin users.
+  unit_price:
+    type: number
+    title: unit_price
+    description: The order edit's unit price.

www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml

@@ -12,3 +12,7 @@ properties:
     type: string
     title: internal_note
     description: A note viewed only by admin users.
+  unit_price:
+    type: number
+    title: unit_price
+    description: The order edit's unit price.

www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml

@@ -14,3 +14,6 @@ properties:
     type: string
     title: avatar_url
     description: The URL of the user's avatar.
+  metadata:
+    type: object
+    description: The user's metadata.

www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml

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