From b354c4dda370bb737ad5d9a76883908d4a449c81 Mon Sep 17 00:00:00 2001 From: Melinda Fekete Date: Fri, 25 Jul 2025 12:41:06 +0200 Subject: [PATCH] docs: update OpenAPI Edge name (#10415) Change the tag of Edge to Unleash Edge in the OpenAPI spec to help with search relevance in the docs --- src/lib/features/metrics/instance/metrics.ts | 2 +- src/lib/openapi/util/openapi-tags.ts | 6 +++++- src/lib/routes/edge-api/index.ts | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/src/lib/features/metrics/instance/metrics.ts b/src/lib/features/metrics/instance/metrics.ts index ca7c9c782a..30e9ff06b5 100644 --- a/src/lib/features/metrics/instance/metrics.ts +++ b/src/lib/features/metrics/instance/metrics.ts @@ -107,7 +107,7 @@ export default class ClientMetricsController extends Controller { permission: NONE, middleware: [ this.openApiService.validPath({ - tags: ['Edge'], + tags: ['Unleash Edge'], summary: 'Send metrics in bulk', description: `This operation accepts batched metrics from any client. Metrics will be inserted into Unleash's metrics storage`, operationId: 'clientBulkMetrics', diff --git a/src/lib/openapi/util/openapi-tags.ts b/src/lib/openapi/util/openapi-tags.ts index 2ab53d95c6..3a778d2fa3 100644 --- a/src/lib/openapi/util/openapi-tags.ts +++ b/src/lib/openapi/util/openapi-tags.ts @@ -48,7 +48,6 @@ const OPENAPI_TAGS = [ name: 'Dependencies', description: 'Manage feature dependencies.', }, - { name: 'Edge', description: 'Endpoints related to Unleash on the Edge.' }, { name: 'Environments', description: @@ -142,6 +141,11 @@ const OPENAPI_TAGS = [ name: 'Telemetry', description: 'API for information about telemetry collection', }, + { + name: 'Unleash Edge', + description: + 'Endpoints related to [Unleash Edge](https://docs.getunleash.io/reference/api/unleash/edge).', + }, { name: 'Unstable', description: diff --git a/src/lib/routes/edge-api/index.ts b/src/lib/routes/edge-api/index.ts index 6a7cd7dff6..984896d41a 100644 --- a/src/lib/routes/edge-api/index.ts +++ b/src/lib/routes/edge-api/index.ts @@ -42,7 +42,7 @@ export default class EdgeController extends Controller { permission: NONE, middleware: [ this.openApiService.validPath({ - tags: ['Edge'], + tags: ['Unleash Edge'], security: [{}], summary: 'Check which tokens are valid', description: