oas: [15/n] improve oas schemas (#9216)
Improve OAS schemas [15/n] Note: validation error will be fixed once #9218 is merged
This commit is contained in:
1 parent
d352ea8122
commit
97b72f4662
22 files changed
+250
-633
No files matched your search
@@ -1,7 +1,7 @@
|
||||
/**
|
||||
* @schema ApiKeyResponse
|
||||
* type: object
|
||||
* description: The api key's details.
|
||||
* description: The API key's details.
|
||||
* x-schemaName: ApiKeyResponse
|
||||
* required:
|
||||
* - id
|
||||
@@ -18,46 +18,47 @@
|
||||
* 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