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,39 @@
+title: Line Item Adjustment
+description: Represents an Line Item Adjustment
+x-resourceId: line_item_adjustment
+required:
+  - item_id
+  - description
+  - amount
+properties:
+  id:
+    type: string
+    description: The invite's ID
+    example: lia_01G8TKE4XYCTHSCK2GDEP47RE1
+  item_id:
+    type: string
+    description: The ID of the line item
+    example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
+  item:
+    description: Available if the relation `item` is expanded.
+    $ref: ./line_item.yaml
+  description:
+    type: string
+    description: The line item's adjustment description
+    example: Adjusted item's price.
+  discount_id:
+    type: string
+    description: The ID of the discount associated with the adjustment
+    example: disc_01F0YESMW10MGHWJKZSDDMN0VN
+  discount:
+    description: Available if the relation `discount` is expanded.
+    $ref: ./discount.yaml
+  amount:
+    type: number
+    description: The adjustment amount
+    example: 1000
+  metadata:
+    type: object
+    description: An optional key-value map with additional details
+    example:
+      car: white