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,43 @@
+title: User
+description: Represents a User who can manage store settings.
+x-resourceId: user
+required:
+  - email
+properties:
+  id:
+    type: string
+    description: The user's ID
+    example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
+  email:
+    description: The email of the User
+    type: string
+    format: email
+  first_name:
+    description: The first name of the User
+    type: string
+    example: Levi
+  last_name:
+    description: The last name of the User
+    type: string
+    example: Bogan
+  api_token:
+    description: An API token associated with the user.
+    type: string
+    example: null
+  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