chore(docs): Updated API Reference (v2) (#9437)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
co-authored by
Shahed Nasser
parent
97c193be1b
commit
21badd069d
@@ -1,5 +1,5 @@
|
||||
type: object
|
||||
description: The api key's details.
|
||||
description: The API key's details.
|
||||
x-schemaName: ApiKeyResponse
|
||||
required:
|
||||
- id
|
||||
@@ -16,44 +16,50 @@ properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The api key's ID.
|
||||
description: The API key's ID.
|
||||
token:
|
||||
type: string
|
||||
title: token
|
||||
description: The api key's token.
|
||||
description: The API key's token.
|
||||
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. For example `sk_...123`.
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The api key's title.
|
||||
description: The API key's title.
|
||||
type:
|
||||
type: string
|
||||
description: >-
|
||||
The API key's type. `secret` API keys are used for authenticating admin
|
||||
users, and `publishable` API key are used for storefronts and similar
|
||||
clients to scope requests to sales channels.
|
||||
enum:
|
||||
- secret
|
||||
- publishable
|
||||
last_used_at:
|
||||
type: string
|
||||
title: last_used_at
|
||||
description: The api key's last used at.
|
||||
description: The date 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.
|
||||
created_at:
|
||||
type: string
|
||||
title: created_at
|
||||
description: The api key's created at.
|
||||
description: The date the API key was created.
|
||||
format: date-time
|
||||
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.
|
||||
revoked_at:
|
||||
type: string
|
||||
title: revoked_at
|
||||
description: The api key's revoked at.
|
||||
description: The date the API key was revoked.
|
||||
format: date-time
|
||||
|
||||
Reference in New Issue
Block a user