mirror of
https://github.com/Unleash/unleash.git
synced 2025-01-11 00:08:30 +01:00
485dab87d4
<!-- 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. -->
Improves the openapi schema specifications for the schemas belonging to
the "Projects" tag.
Expected error codes/http statues, descriptions, and example data
---------
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
94 lines
3.3 KiB
TypeScript
94 lines
3.3 KiB
TypeScript
import { FromSchema } from 'json-schema-to-ts';
|
|
import { ApiTokenType } from '../../types/models/api-token';
|
|
|
|
export const apiTokenSchema = {
|
|
$id: '#/components/schemas/apiTokenSchema',
|
|
type: 'object',
|
|
additionalProperties: false,
|
|
required: [
|
|
'secret',
|
|
'tokenName',
|
|
'type',
|
|
'project',
|
|
'projects',
|
|
'createdAt',
|
|
],
|
|
description:
|
|
'An overview of an [Unleash API token](https://docs.getunleash.io/reference/api-tokens-and-client-keys).',
|
|
properties: {
|
|
secret: {
|
|
type: 'string',
|
|
description: 'The token used for authentication.',
|
|
example: 'project:environment.xyzrandomstring',
|
|
},
|
|
username: {
|
|
type: 'string',
|
|
deprecated: true,
|
|
description:
|
|
'This property was deprecated in Unleash v5. Prefer the `tokenName` property instead.',
|
|
example: 'a-name',
|
|
},
|
|
tokenName: {
|
|
type: 'string',
|
|
description: 'A unique name for this particular token',
|
|
example: 'some-user',
|
|
},
|
|
type: {
|
|
type: 'string',
|
|
enum: Object.values(ApiTokenType),
|
|
description: 'The type of API token',
|
|
example: 'client',
|
|
},
|
|
environment: {
|
|
type: 'string',
|
|
description:
|
|
'The environment the token has access to. `*` if it has access to all environments.',
|
|
example: 'development',
|
|
},
|
|
project: {
|
|
type: 'string',
|
|
description: 'The project this token belongs to.',
|
|
example: 'developerexperience',
|
|
},
|
|
projects: {
|
|
type: 'array',
|
|
description:
|
|
'The list of projects this token has access to. If the token has access to specific projects they will be listed here. If the token has access to all projects it will be represented as `[*]`',
|
|
items: {
|
|
type: 'string',
|
|
},
|
|
example: ['developerexperience', 'enterprisegrowth'],
|
|
},
|
|
expiresAt: {
|
|
type: 'string',
|
|
format: 'date-time',
|
|
nullable: true,
|
|
description: `The token's expiration date. NULL if the token doesn't have an expiration set.`,
|
|
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.',
|
|
},
|
|
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 the token has not yet been used for authentication.',
|
|
},
|
|
alias: {
|
|
type: 'string',
|
|
nullable: true,
|
|
description: `Alias is no longer in active use and will often be NULL. It's kept around as a way of allowing old proxy tokens created with the old metadata format to keep working.`,
|
|
example: 'randomid-or-some-alias',
|
|
},
|
|
},
|
|
components: {},
|
|
} as const;
|
|
|
|
export type ApiTokenSchema = FromSchema<typeof apiTokenSchema>;
|