[Fleet] Add OpenAPI tags to help group Fleet API requests

x-pack/plugins/fleet/common/openapi/entrypoint.yaml

@@ -13,18 +13,18 @@ servers:
   - url: 'http://localhost:5601/api/fleet'
     description: local
 paths:
-  # plugin-wide endpoint(s)
+  # Fleet internals
+  /health_check:
+    $ref: paths/health_check.yaml
   /setup:
     $ref: paths/setup.yaml
   /settings:
     $ref: paths/settings.yaml
-  # App endpoints
-  /health_check:
-    $ref: paths/health_check.yaml
   /service-tokens:
     $ref: paths/service_tokens_deprecated.yaml
   /service_tokens:
     $ref: paths/service_tokens.yaml
+
   # EPM / integrations endpoints
   /epm/verification_key_id:
     $ref: paths/epm@verification_key_id.yaml
@@ -44,7 +44,8 @@ paths:
     $ref: paths/epm@get_file.yaml
   '/epm/packages/{pkgName}/stats':
     $ref: 'paths/epm@packages@{pkg_name}@stats.yaml'
-  # Agent-related endpoints
+
+  # Agent endpoints
   /agents/setup:
     $ref: paths/agents@setup.yaml
   /agent-status:
@@ -87,6 +88,7 @@ paths:
     $ref: 'paths/agents@{agent_id}@request_diagnostics.yaml'
   /agents/bulk_request_diagnostics:
     $ref: 'paths/agents@bulk_request_diagnostics.yaml'
+
   #  Agent policies endpoints
   /agent_policies:
     $ref: paths/agent_policies.yaml
@@ -102,9 +104,11 @@ paths:
     $ref: paths/agent_policies@_bulk_get.yaml
   /agent_policies/delete:
     $ref: paths/agent_policies@delete.yaml
+
   # Data streams endpoints
   /data_streams:
     $ref: paths/data_streams.yaml
+
   #  Enrollment endpoints
   /enrollment-api-keys:
     $ref: paths/enrollment_api_keys_deprecated.yaml
@@ -114,6 +118,7 @@ paths:
     $ref: paths/enrollment_api_keys.yaml
   '/enrollment_api_keys/{keyId}':
     $ref: 'paths/enrollment_api_keys@{key_id}.yaml'
+
   #  Package policies endpoints
   /package_policies:
     $ref: paths/package_policies.yaml
@@ -127,27 +132,33 @@ paths:
     $ref: paths/package_policies@upgrade_dryrun.yaml
   '/package_policies/{packagePolicyId}':
     $ref: 'paths/package_policies@{package_policy_id}.yaml'
+
   # Outputs
   /outputs:
     $ref: paths/outputs.yaml
   /outputs/{outputId}:
     $ref: paths/outputs@{output_id}.yaml
+  /logstash_api_keys:
+    $ref: paths/logstash_api_keys.yaml
+
+  # Agent binary download sources
   /agent_download_sources:
     $ref: paths/agent_download_sources.yaml
   /agent_download_sources/{sourceId}:
     $ref: paths/agent_download_sources@{source_id}.yaml
-  /logstash_api_keys:
-    $ref: paths/logstash_api_keys.yaml
+
   # Fleet server hosts
   /fleet_server_hosts:
     $ref: paths/fleet_server_hosts.yaml
   /fleet_server_hosts/{itemId}:
     $ref: paths/fleet_server_hosts@{item_id}.yaml
+
   # Fleet proxies
   /proxies:
     $ref: paths/proxies.yaml
   /proxies/{itemId}:
     $ref: paths/proxies@{item_id}.yaml
+
   # K8s
   /kubernetes:
     $ref: paths/kubernetes.yaml

x-pack/plugins/fleet/common/openapi/paths/agent_download_sources.yaml

@@ -1,6 +1,7 @@
 get:
-  summary: Agent Download Sources
-  tags: []
+  summary: List agent binary download sources
+  tags:
+    - Agent binary download sources
   responses:
     '200':
       description: OK
@@ -23,9 +24,9 @@ get:
       $ref: ../components/responses/error.yaml
   operationId: get-download-sources
 post:
-  summary: Agent Download Sources
-  description: 'Create a new agent download source'
-  tags: []
+  summary: Create agent binary download source
+  tags:
+    - Agent binary download sources
   responses:
     '200':
       description: OK

x-pack/plugins/fleet/common/openapi/paths/agent_download_sources@{source_id}.yaml

@@ -1,6 +1,7 @@
 get:
-  summary: Agent Download Sources - Info
-  tags: []
+  summary: Get agent binary download source by ID
+  tags:
+    - Agent binary download sources
   responses:
     '200':
       description: OK
@@ -23,7 +24,9 @@ parameters:
     in: path
     required: true
 delete:
-  summary: Agent Download Sources - Delete
+  summary: Delete agent binary download source by ID
+  tags:
+    - Agent binary download sources
   operationId: delete-download-source
   responses:
     '200':
@@ -42,7 +45,9 @@ delete:
   parameters:
     - $ref: ../components/headers/kbn_xsrf.yaml
 put:
-  summary: Agent Download Sources - Update
+  summary: Update agent binary download source by ID
+  tags:
+    - Agent binary download sources
   operationId: update-download-source
   requestBody:
     content:

x-pack/plugins/fleet/common/openapi/paths/agent_policies.yaml

@@ -1,6 +1,7 @@
 get:
-  summary: Agent policies - List
-  tags: []
+  summary: List agent policies
+  tags:
+    - Agent policies
   responses:
     '200':
       description: OK
@@ -44,8 +45,9 @@ get:
 
   description: ''
 post:
-  summary: Agent policy - Create
-  tags: []
+  summary: Create agent policy
+  tags:
+    - Agent policies
   responses:
     '200':
       description: OK

x-pack/plugins/fleet/common/openapi/paths/agent_policies@_bulk_get.yaml

@@ -1,6 +1,7 @@
 post:
-  summary: Agent policies - Bulk Get
-  tags: []
+  summary: Bulk get agent policies
+  tags:
+    - Agent policies
   requestBody:
     content:
       application/json:

x-pack/plugins/fleet/common/openapi/paths/agent_policies@delete.yaml

@@ -1,5 +1,7 @@
 post:
-  summary: Agent policy - Delete
+  summary: Delete agent policy by ID
+  tags:
+    - Agent policies
   operationId: delete-agent-policy
   responses:
     '200':

x-pack/plugins/fleet/common/openapi/paths/agent_policies@{agent_policy_id}.yaml

@@ -5,8 +5,9 @@ parameters:
     in: path
     required: true
 get:
-  summary: Agent policy - Info
-  tags: []
+  summary: Get agent policy by ID
+  tags:
+    - Agent policies
   responses:
     '200':
       description: OK
@@ -25,8 +26,9 @@ get:
   description: Get one agent policy
   parameters: []
 put:
-  summary: Agent policy - Update
-  tags: []
+  summary: Update agent policy by ID
+  tags:
+    - Agent policies
   responses:
     '200':
       description: OK

x-pack/plugins/fleet/common/openapi/paths/agent_policies@{agent_policy_id}@copy.yaml

@@ -5,7 +5,9 @@ parameters:
     in: path
     required: true
 post:
-  summary: Agent policy - copy one policy
+  summary: Copy agent policy by ID
+  tags:
+    - Agent policies
   operationId: agent-policy-copy
   parameters:
     - $ref: ../components/headers/kbn_xsrf.yaml
@@ -36,4 +38,3 @@ post:
           required:
             - name
     description: ''
-

x-pack/plugins/fleet/common/openapi/paths/agent_policies@{agent_policy_id}@download.yaml

@@ -1,6 +1,7 @@
-
 get:
-  summary: Agent policy - Download
+  summary: Download agent policy by ID
+  tags:
+    - Agent policies
   operationId: agent-policy-download
   responses:
     '200':

x-pack/plugins/fleet/common/openapi/paths/agent_policies@{agent_policy_id}@full.yaml

@@ -1,6 +1,7 @@
-
 get:
-  summary: Agent policy - Get full policy
+  summary: Get full agent policy by ID
+  tags:
+    - Agent policies
   operationId: agent-policy-full
   responses:
     '200':

x-pack/plugins/fleet/common/openapi/paths/agent_status.yaml

@@ -1,6 +1,7 @@
 get:
-  summary: Agents - Summary stats
-  tags: []
+  summary: Get agent status summary
+  tags:
+    - Agent status
   responses:
     '200':
       description: OK
@@ -29,7 +30,7 @@ get:
               updating:
                 type: integer
               all:
-                type: integer 
+                type: integer
               active:
                 type: integer
             required:

x-pack/plugins/fleet/common/openapi/paths/agent_status@data.yaml

@@ -1,6 +1,7 @@
 get:
-  summary: Agents - Get incoming data
-  tags: []
+  summary: Get incoming agent data
+  tags:
+    - Agent status
   responses:
     '200':
       description: OK

x-pack/plugins/fleet/common/openapi/paths/agent_status_deprecated.yaml

@@ -1,6 +1,7 @@
 get:
-  summary: Agents - Summary stats
-  tags: []
+  summary: Get agent status summary
+  tags:
+    - Agent status
   responses:
     '200':
       description: OK

x-pack/plugins/fleet/common/openapi/paths/agent_tags.yaml

@@ -1,6 +1,7 @@
 get:
-  summary: Agent Tags - List
-  description: List all agent tags
+  summary: List agent tags
+  tags:
+    - Agents
   responses:
     '200':
       description: OK

x-pack/plugins/fleet/common/openapi/paths/agents.yaml

@@ -1,6 +1,7 @@
 get:
-  summary: Agents - List
-  tags: []
+  summary: List agents
+  tags:
+    - Agents
   responses:
     '200':
       description: OK

x-pack/plugins/fleet/common/openapi/paths/agents@action_status.yaml

@@ -1,8 +1,10 @@
 get:
-  summary: Agents - Action status
+  summary: Get agent action status
+  tags:
+    - Agent actions
   parameters:
-  - $ref: ../components/parameters/page_size.yaml
-  - $ref: ../components/parameters/page_index.yaml
+    - $ref: ../components/parameters/page_size.yaml
+    - $ref: ../components/parameters/page_index.yaml
   responses:
     '200':
       description: OK
@@ -33,7 +35,7 @@ get:
                     nbAgentsAck:
                       type: number
                     nbAgentsFailed:
-                      type: number  
+                      type: number
                     version:
                       type: string
                     startTime:
@@ -49,7 +51,7 @@ get:
                     newPolicyId:
                       type: string
                     creationTime:
-                      type: string          
+                      type: string
                   required:
                     - actionId
                     - complete
@@ -63,4 +65,4 @@ get:
               - items
     '400':
       $ref: ../components/responses/error.yaml
-  operationId: agents-action-status
+  operationId: agents-action-status

x-pack/plugins/fleet/common/openapi/paths/agents@bulk_reassign.yaml

@@ -1,16 +1,17 @@
 post:
-  summary: Agents - Bulk reassign
-  tags: []
+  summary: Bulk reassign agents
+  tags:
+    - Agents
   responses:
     '200':
-        description: OK
-        content:
-          application/json:
-            schema:
-              type: object
-              properties:
-                actionId: 
-                  type: string
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              actionId:
+                type: string
     '400':
       $ref: ../components/responses/error.yaml
   operationId: bulk-reassign-agents
@@ -38,4 +39,4 @@ post:
             - agents
         example:
           policy_id: policy_id
-          agents: "fleet-agents.policy_id : (\"policy1\" or \"policy2\")"
+          agents: 'fleet-agents.policy_id : ("policy1" or "policy2")'