mirror of
https://github.com/Unleash/unleash.git
synced 2024-11-01 19:07:38 +01:00
546f9953a7
<!-- Thanks for creating a PR! To make it easier for reviewers and
everyone else to understand what your changes relate to, please add some
relevant content to the headings below. Feel free to ignore or delete
sections that you don't think are relevant. Thank you! ❤️ -->
## About the changes
<!-- Describe the changes introduced. What are they and why are they
being introduced? Feel free to also add screenshots or steps to view the
changes if they're visual. -->
OpenAPI schema updates for Personal Access Tokens, http statuses,
property types and examples, return types
---------
Co-authored-by: Nuno Góis <github@nunogois.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
50 lines
2.1 KiB
TypeScript
50 lines
2.1 KiB
TypeScript
import { FromSchema } from 'json-schema-to-ts';
|
|
|
|
export const patSchema = {
|
|
$id: '#/components/schemas/patSchema',
|
|
type: 'object',
|
|
description:
|
|
'An overview of a [Personal Access Token](https://docs.getunleash.io/how-to/how-to-create-personal-access-tokens).',
|
|
properties: {
|
|
id: {
|
|
type: 'integer',
|
|
description:
|
|
'The unique identification number for this Personal Access Token. (This property is set by Unleash when the token is created and cannot be set manually: if you provide a value when creating a PAT, Unleash will ignore it.)',
|
|
example: 1,
|
|
minimum: 1,
|
|
},
|
|
secret: {
|
|
type: 'string',
|
|
description:
|
|
'The token used for authentication. (This property is set by Unleash when the token is created and cannot be set manually: if you provide a value when creating a PAT, Unleash will ignore it.)',
|
|
example: 'user:xyzrandomstring',
|
|
},
|
|
expiresAt: {
|
|
type: 'string',
|
|
format: 'date-time',
|
|
description: `The token's expiration date.`,
|
|
example: '2023-04-19T08:15:14.000Z',
|
|
},
|
|
createdAt: {
|
|
type: 'string',
|
|
format: 'date-time',
|
|
example: '2023-04-19T08:15:14.000Z',
|
|
description:
|
|
'When the token was created. (This property is set by Unleash when the token is created and cannot be set manually: if you provide a value when creating a PAT, Unleash will ignore it.)',
|
|
},
|
|
seenAt: {
|
|
type: 'string',
|
|
format: 'date-time',
|
|
nullable: true,
|
|
example: '2023-04-19T08:15:14.000Z',
|
|
description:
|
|
'When the token was last seen/used to authenticate with. `null` if it has not been used yet. (This property is set by Unleash when the token is created and cannot be set manually: if you provide a value when creating a PAT, Unleash will ignore it.)',
|
|
},
|
|
},
|
|
components: {
|
|
schemas: {},
|
|
},
|
|
} as const;
|
|
|
|
export type PatSchema = FromSchema<typeof patSchema>;
|