OpenAPI tags

Unleash · Jan 26, 2023 · 9a1011c · 9a1011c
1 parent ee0d3f7
commit 9a1011c
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 6 deletions.
diff --git a/src/lib/openapi/util/openapi-tags.ts b/src/lib/openapi/util/openapi-tags.ts
@@ -13,6 +13,11 @@ const OPENAPI_TAGS = [
         description:
             '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',
         description:
@@ -96,10 +101,20 @@ const OPENAPI_TAGS = [
             'Experimental endpoints that may change or disappear at any time.',
     },
     { 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',
         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;
 
 // make the export mutable, so it can be used in a schema

diff --git a/src/lib/routes/admin-api/user/pat.ts b/src/lib/routes/admin-api/user/pat.ts
@@ -39,7 +39,7 @@ export default class PatController extends Controller {
             permission: NONE,
             middleware: [
                 openApiService.validPath({
-                    tags: ['API tokens'],
+                    tags: ['Personal access tokens'],
                     operationId: 'getPats',
                     responses: { 200: createResponseSchema('patsSchema') },
                 }),
@@ -52,7 +52,7 @@ export default class PatController extends Controller {
             permission: NONE,
             middleware: [
                 openApiService.validPath({
-                    tags: ['API tokens'],
+                    tags: ['Personal access tokens'],
                     operationId: 'createPat',
                     requestBody: createRequestSchema('patSchema'),
                     responses: { 200: createResponseSchema('patSchema') },
@@ -68,7 +68,7 @@ export default class PatController extends Controller {
             permission: NONE,
             middleware: [
                 openApiService.validPath({
-                    tags: ['API tokens'],
+                    tags: ['Personal access tokens'],
                     operationId: 'deletePat',
                     responses: { 200: emptyResponse },
                 }),

diff --git a/src/lib/routes/proxy-api/index.ts b/src/lib/routes/proxy-api/index.ts
@@ -63,7 +63,7 @@ export default class ProxyController extends Controller {
             permission: NONE,
             middleware: [
                 this.services.openApiService.validPath({
-                    tags: ['Unstable'],
+                    tags: ['Frontend API'],
                     operationId: 'getFrontendFeatures',
                     responses: {
                         200: createResponseSchema('proxyFeaturesSchema'),
@@ -93,7 +93,7 @@ export default class ProxyController extends Controller {
             permission: NONE,
             middleware: [
                 this.services.openApiService.validPath({
-                    tags: ['Unstable'],
+                    tags: ['Frontend API'],
                     operationId: 'registerFrontendMetrics',
                     requestBody: createRequestSchema('proxyMetricsSchema'),
                     responses: { 200: emptyResponse },
@@ -108,7 +108,7 @@ export default class ProxyController extends Controller {
             permission: NONE,
             middleware: [
                 this.services.openApiService.validPath({
-                    tags: ['Unstable'],
+                    tags: ['Frontend API'],
                     operationId: 'registerFrontendClient',
                     requestBody: createRequestSchema('proxyClientSchema'),
                     responses: { 200: emptyResponse },