[HTTP/OAS] Add operation tags for APM APIs (elastic#181353)

saikatsarkar056 · Jun 13, 2024 · 38c0bbd · 38c0bbd
1 parent 1a24fbf
commit 38c0bbd
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 3 deletions.
diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml
@@ -2,11 +2,21 @@ openapi: 3.0.0
 info:
   title: APM UI
   version: 1.0.0
+tags:
+  - name: APM agent keys
+    description: >
+      Configure APM agent keys to authorize requests from APM agents to the APM Server.
+  - name: APM annotations
+    description: >
+      Annotate visualizations in the APM app with significant events.
+      Annotations enable you to easily see how events are impacting the performance of your applications.
 paths:
   /api/apm/agent_keys:
     post:
       summary: Create an APM agent key
       description: Create a new agent key for APM.
+      tags:
+        - APM agent keys
       requestBody:
         required: true
         content:
@@ -46,6 +56,8 @@ paths:
     get:
       summary: Search for annotations
       description: Search for annotations related to a specific service.
+      tags:
+        - APM annotations
       parameters:
         - name: serviceName
           in: path
@@ -98,6 +110,8 @@ paths:
     post:
       summary: Create a service annotation
       description: Create a new annotation for a specific service.
+      tags:
+        - APM annotations
       parameters:
         - name: serviceName
           in: path

diff --git a/x-pack/plugins/observability_solution/apm/server/routes/agent_keys/route.ts b/x-pack/plugins/observability_solution/apm/server/routes/agent_keys/route.ts
@@ -91,7 +91,7 @@ const invalidateAgentKeyRoute = createApmServerRoute({
 
 const createAgentKeyRoute = createApmServerRoute({
   endpoint: 'POST /api/apm/agent_keys 2023-10-31',
-  options: { tags: ['access:apm', 'access:apm_write'] },
+  options: { tags: ['access:apm', 'access:apm_write', 'oas-tag:APM agent keys'] },
   params: t.type({
     body: t.type({
       name: t.string,

diff --git a/x-pack/plugins/observability_solution/apm/server/routes/services/route.ts b/x-pack/plugins/observability_solution/apm/server/routes/services/route.ts
@@ -372,7 +372,7 @@ const serviceAnnotationsRoute = createApmServerRoute({
     }),
     query: t.intersection([environmentRt, rangeRt]),
   }),
-  options: { tags: ['access:apm'] },
+  options: { tags: ['access:apm', 'oas-tag:APM annotations'] },
   handler: async (resources): Promise<ServiceAnnotationResponse> => {
     const apmEventClient = await getApmEventClient(resources);
     const { params, plugins, context, request, logger, config } = resources;
@@ -416,7 +416,7 @@ const serviceAnnotationsRoute = createApmServerRoute({
 const serviceAnnotationsCreateRoute = createApmServerRoute({
   endpoint: 'POST /api/apm/services/{serviceName}/annotation 2023-10-31',
   options: {
-    tags: ['access:apm', 'access:apm_write'],
+    tags: ['access:apm', 'access:apm_write', 'oas-tag:APM annotations'],
   },
   params: t.type({
     path: t.type({

diff --git a/x-pack/plugins/observability_solution/apm/server/routes/typings.ts b/x-pack/plugins/observability_solution/apm/server/routes/typings.ts
@@ -56,6 +56,8 @@ export interface APMRouteCreateOptions {
       | 'access:ml:canCreateJob'
       | 'access:ml:canCloseJob'
       | 'access:ai_assistant'
+      | 'oas-tag:APM agent keys'
+      | 'oas-tag:APM annotations'
     >;
     body?: { accepts: Array<'application/json' | 'multipart/form-data'> };
     disableTelemetry?: boolean;