chore(docs): Refactor API Reference (#1883)

2022-08-05 14:06:12 +02:00
parent b126ab4dec
commit 73383cc466
625 changed files with 52358 additions and 11660 deletions
@@ -0,0 +1,83 @@
+title: Claim Item
+description: >-
+  Represents a claimed item along with information about the reasons for the
+  claim.
+x-resourceId: claim_item
+required:
+  - claim_order_id
+  - item_id
+  - variant_id
+  - reason
+  - quantity
+properties:
+  id:
+    type: string
+    description: The claim item's ID
+    example: citm_01G8ZH853Y6TFXWPG5EYE81X63
+  images:
+    type: array
+    description: Available if the relation `images` is expanded.
+    items:
+      $ref: ./claim_image.yaml
+  claim_order_id:
+    description: The ID of the claim this item is associated with.
+    type: string
+  claim_order:
+    description: A claim order object. Available if the relation `claim_order` is expanded.
+    type: object
+  item_id:
+    description: The ID of the line item that the claim item refers to.
+    type: string
+    example: item_01G8ZM25TN49YV9EQBE2NC27KC
+  item:
+    description: Available if the relation `item` is expanded.
+    $ref: ./line_item.yaml
+  variant_id:
+    description: The ID of the product variant that is claimed.
+    type: string
+    example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
+  variant:
+    description: A variant object. Available if the relation `variant` is expanded.
+    type: object
+  reason:
+    description: The reason for the claim
+    type: string
+    enum:
+      - missing_item
+      - wrong_item
+      - production_failure
+      - other
+  note:
+    description: An optional note about the claim, for additional information
+    type: string
+    example: I don't like it.
+  quantity:
+    description: >-
+      The quantity of the item that is being claimed; must be less than or equal
+      to the amount purchased in the original order.
+    type: integer
+    example: 1
+  tags:
+    description: >-
+      User defined tags for easy filtering and grouping. Available if the
+      relation 'tags' is expanded.
+    type: array
+    items:
+      $ref: ./claim_tag.yaml
+  created_at:
+    type: string
+    description: The date with timezone at which the resource was created.
+    format: date-time
+  updated_at:
+    type: string
+    description: The date with timezone at which the resource was updated.
+    format: date-time
+  deleted_at:
+    type: string
+    description: The date with timezone at which the resource was deleted.
+    format: date-time
+  metadata:
+    type: object
+    description: An optional key-value map with additional details
+    example:
+      car: white