oas: [1/n] improve oas schemas (#9039)

This commit is contained in:
Shahed Nasser
2024-09-06 18:52:51 +03:00
committed by GitHub
parent cd909f9db3
commit 0482b7751d
21 changed files with 108 additions and 110 deletions
@@ -1,7 +1,7 @@
/**
* @schema AdminApiKey
* type: object
* description: The api key's details.
* description: The API key's details.
* x-schemaName: AdminApiKey
* required:
* - id
@@ -26,39 +26,40 @@
* 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
*
*/