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,38 @@
+title: Claim Image
+description: Represents photo documentation of a claim.
+x-resourceId: claim_image
+required:
+  - claim_item_id
+  - url
+properties:
+  id:
+    type: string
+    description: The claim image's ID
+    example: cimg_01G8ZH853Y6TFXWPG5EYE81X63
+  claim_item_id:
+    type: string
+    description: The ID of the claim item associated with the image
+  claim_item:
+    description: A claim item object. Available if the relation `claim_item` is expanded.
+    type: object
+  url:
+    type: string
+    description: The URL of the image
+    format: uri
+  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