chore(docs): Generated API Reference (#2882)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2022-12-22 17:09:49 +02:00
parent 233d6904f8
commit 4814045036
477 changed files with 17312 additions and 17713 deletions
@@ -0,0 +1,36 @@
+title: Publishable API key
+description: >-
+  Publishable API key defines scopes (i.e. resources) that are available within
+  a request.
+type: object
+properties:
+  id:
+    type: string
+    description: The key's ID
+    example: pk_01G1G5V27GYX4QXNARRQCW1N8T
+  created_by:
+    type: string
+    description: The unique identifier of the user that created the key.
+    example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
+  created_by_user:
+    description: A user object. Available if the relation `created_by_user` is expanded.
+    type: object
+  created_at:
+    type: string
+    description: The date with timezone at which the resource was created.
+    format: date-time
+  revoked_by:
+    type: string
+    description: The unique identifier of the user that revoked the key.
+    example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
+  revoked_by_user:
+    description: A user object. Available if the relation `revoked_by_user` is expanded.
+    type: object
+  revoked_at:
+    type: string
+    description: The date with timezone at which the key was revoked.
+    format: date-time
+  updated_at:
+    type: string
+    description: The date with timezone at which the resource was updated.
+    format: date-time