Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-08-18 13:48:58 +02:00
Code Issues Projects Releases Wiki Activity

OpenAPI tags

Browse Source
This commit is contained in:
Gastón Fournier 2023-01-26 10:16:38 +01:00
parent ee0d3f7f6f
commit 9a1011cc8b
No known key found for this signature in database
GPG Key ID: BC3E6CD5E81633B8
3 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/lib/openapi/util/openapi-tags.ts
View File

@ -13,6 +13,11 @@ const OPENAPI_TAGS = [
description: description:
'Create, update, and delete [Unleash API tokens](https://docs.getunleash.io/reference/api-tokens-and-client-keys).', 'Create, update, and delete [Unleash API tokens](https://docs.getunleash.io/reference/api-tokens-and-client-keys).',
}, },
{
name: 'Personal access tokens',
description:
'Create, update, and delete [Personal access tokens](https://docs.getunleash.io/reference/api-tokens-and-client-keys#personal-access-tokens).',
},
{ {
name: 'Archive', name: 'Archive',
description: description:
@ -96,10 +101,20 @@ const OPENAPI_TAGS = [
'Experimental endpoints that may change or disappear at any time.', 'Experimental endpoints that may change or disappear at any time.',
}, },
{ name: 'Edge', description: 'Endpoints related to Unleash on the Edge.' }, { name: 'Edge', description: 'Endpoints related to Unleash on the Edge.' },
{
name: 'Frontend API',
description:
'API for connecting client-side (frontend) applications to Unleash.',
},
{ {
name: 'Maintenance', name: 'Maintenance',
description: 'Enable/disable the maintenance mode of Unleash.', description: 'Enable/disable the maintenance mode of Unleash.',
}, },
{
name: 'Change Requests',
description:
'API for managing [change requests](https://docs.getunleash.io/reference/change-requests).',
},
] as const; ] as const;
// make the export mutable, so it can be used in a schema // make the export mutable, so it can be used in a schema

6
src/lib/routes/admin-api/user/pat.ts
View File

@ -39,7 +39,7 @@ export default class PatController extends Controller {
permission: NONE, permission: NONE,
middleware: [ middleware: [
openApiService.validPath({ openApiService.validPath({
tags: ['API tokens'], tags: ['Personal access tokens'],
operationId: 'getPats', operationId: 'getPats',
responses: { 200: createResponseSchema('patsSchema') }, responses: { 200: createResponseSchema('patsSchema') },
}), }),
@ -52,7 +52,7 @@ export default class PatController extends Controller {
permission: NONE, permission: NONE,
middleware: [ middleware: [
openApiService.validPath({ openApiService.validPath({
tags: ['API tokens'], tags: ['Personal access tokens'],
operationId: 'createPat', operationId: 'createPat',
requestBody: createRequestSchema('patSchema'), requestBody: createRequestSchema('patSchema'),
responses: { 200: createResponseSchema('patSchema') }, responses: { 200: createResponseSchema('patSchema') },
@ -68,7 +68,7 @@ export default class PatController extends Controller {
permission: NONE, permission: NONE,
middleware: [ middleware: [
openApiService.validPath({ openApiService.validPath({
tags: ['API tokens'], tags: ['Personal access tokens'],
operationId: 'deletePat', operationId: 'deletePat',
responses: { 200: emptyResponse }, responses: { 200: emptyResponse },
}), }),

6
src/lib/routes/proxy-api/index.ts
View File

@ -63,7 +63,7 @@ export default class ProxyController extends Controller {
permission: NONE, permission: NONE,
middleware: [ middleware: [
this.services.openApiService.validPath({ this.services.openApiService.validPath({
tags: ['Unstable'], tags: ['Frontend API'],
operationId: 'getFrontendFeatures', operationId: 'getFrontendFeatures',
responses: { responses: {
200: createResponseSchema('proxyFeaturesSchema'), 200: createResponseSchema('proxyFeaturesSchema'),
@ -93,7 +93,7 @@ export default class ProxyController extends Controller {
permission: NONE, permission: NONE,
middleware: [ middleware: [
this.services.openApiService.validPath({ this.services.openApiService.validPath({
tags: ['Unstable'], tags: ['Frontend API'],
operationId: 'registerFrontendMetrics', operationId: 'registerFrontendMetrics',
requestBody: createRequestSchema('proxyMetricsSchema'), requestBody: createRequestSchema('proxyMetricsSchema'),
responses: { 200: emptyResponse }, responses: { 200: emptyResponse },
@ -108,7 +108,7 @@ export default class ProxyController extends Controller {
permission: NONE, permission: NONE,
middleware: [ middleware: [
this.services.openApiService.validPath({ this.services.openApiService.validPath({
tags: ['Unstable'], tags: ['Frontend API'],
operationId: 'registerFrontendClient', operationId: 'registerFrontendClient',
requestBody: createRequestSchema('proxyClientSchema'), requestBody: createRequestSchema('proxyClientSchema'),
responses: { 200: emptyResponse }, responses: { 200: emptyResponse },