chore(docs): Updated API Reference (v2) (#9148)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
a63f6910d0
commit
56ee4d6aad
@@ -1,5 +1,5 @@
|
||||
type: object
|
||||
description: The api key's details.
|
||||
description: The API key's details.
|
||||
x-schemaName: AdminApiKey
|
||||
required:
|
||||
- id
|
||||
@@ -24,37 +24,44 @@ properties:
|
||||
redacted:
|
||||
type: string
|
||||
title: redacted
|
||||
description: The api key's redacted.
|
||||
description: >-
|
||||
The redacted form of the API key's token. This is useful when showing
|
||||
portion of the token.
|
||||
example: sk_...123
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The api key's title.
|
||||
type:
|
||||
type: string
|
||||
description: The api key's type.
|
||||
description: >-
|
||||
The api key's type. `secret` is used for a user's API key, whereas
|
||||
`publishable` is used for Publishable API keys.
|
||||
enum:
|
||||
- secret
|
||||
- publishable
|
||||
last_used_at:
|
||||
type: string
|
||||
title: last_used_at
|
||||
description: The api key's last used at.
|
||||
description: The date and time the API key was last used.
|
||||
format: date-time
|
||||
created_by:
|
||||
type: string
|
||||
title: created_by
|
||||
description: The api key's created by.
|
||||
description: The ID of the user that created the API key, if available.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The api key's created at.
|
||||
description: The date and time the API key was created.
|
||||
revoked_by:
|
||||
type: string
|
||||
title: revoked_by
|
||||
description: The api key's revoked by.
|
||||
description: The ID of the user that revoked the API key, if available.
|
||||
revoked_at:
|
||||
type: string
|
||||
title: revoked_at
|
||||
description: The api key's revoked at.
|
||||
description: >-
|
||||
The date and time the API key was revoked. The API key is considered
|
||||
revoked when this property is set.
|
||||
format: date-time
|
||||
|
||||
Reference in New Issue
Block a user