chore(docs): Generated API reference (#2788)
This commit is contained in:
37
docs/api/admin/components/schemas/publishable_api_key.yaml
Normal file
37
docs/api/admin/components/schemas/publishable_api_key.yaml
Normal file
@@ -0,0 +1,37 @@
|
||||
title: Publishable API key
|
||||
description: >-
|
||||
Publishable API key defines scopes (i.e. resources) that are available within
|
||||
a request.
|
||||
x-resourceId: publishable_api_key
|
||||
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
|
||||
Reference in New Issue
Block a user