1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-08-23 13:46:45 +02:00

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
This commit is contained in:
Melinda Fekete 2025-07-25 12:41:06 +02:00 committed by GitHub
parent d278185228
commit b354c4dda3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 7 additions and 3 deletions

View File

@ -107,7 +107,7 @@ export default class ClientMetricsController extends Controller {
permission: NONE, permission: NONE,
middleware: [ middleware: [
this.openApiService.validPath({ this.openApiService.validPath({
tags: ['Edge'], tags: ['Unleash Edge'],
summary: 'Send metrics in bulk', summary: 'Send metrics in bulk',
description: `This operation accepts batched metrics from any client. Metrics will be inserted into Unleash's metrics storage`, description: `This operation accepts batched metrics from any client. Metrics will be inserted into Unleash's metrics storage`,
operationId: 'clientBulkMetrics', operationId: 'clientBulkMetrics',

View File

@ -48,7 +48,6 @@ const OPENAPI_TAGS = [
name: 'Dependencies', name: 'Dependencies',
description: 'Manage feature dependencies.', description: 'Manage feature dependencies.',
}, },
{ name: 'Edge', description: 'Endpoints related to Unleash on the Edge.' },
{ {
name: 'Environments', name: 'Environments',
description: description:
@ -142,6 +141,11 @@ const OPENAPI_TAGS = [
name: 'Telemetry', name: 'Telemetry',
description: 'API for information about telemetry collection', 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', name: 'Unstable',
description: description:

View File

@ -42,7 +42,7 @@ export default class EdgeController extends Controller {
permission: NONE, permission: NONE,
middleware: [ middleware: [
this.openApiService.validPath({ this.openApiService.validPath({
tags: ['Edge'], tags: ['Unleash Edge'],
security: [{}], security: [{}],
summary: 'Check which tokens are valid', summary: 'Check which tokens are valid',
description: description: