From f07a288911ece77892b5bf425f9cbf3782c01866 Mon Sep 17 00:00:00 2001 From: lcawl Date: Fri, 8 Nov 2024 11:52:43 -0800 Subject: [PATCH] [OpenAPI][Fleet] Add operation summaries --- .../fleet/server/routes/agent/index.ts | 53 ++++++++++--------- .../fleet/server/routes/agent_policy/index.ts | 34 +++++++----- .../plugins/fleet/server/routes/app/index.ts | 4 +- .../fleet/server/routes/data_streams/index.ts | 2 +- .../server/routes/download_source/index.ts | 13 +++-- .../server/routes/enrollment_api_key/index.ts | 10 ++-- .../plugins/fleet/server/routes/epm/index.ts | 40 +++++++------- .../server/routes/fleet_proxies/index.ts | 13 +++-- .../server/routes/fleet_server_hosts/index.ts | 13 +++-- .../fleet/server/routes/health_check/index.ts | 2 +- .../routes/message_signing_service/index.ts | 2 +- .../fleet/server/routes/output/index.ts | 17 +++--- .../server/routes/package_policy/index.ts | 22 ++++---- .../fleet/server/routes/settings/index.ts | 10 ++-- .../fleet/server/routes/setup/index.ts | 6 +-- .../server/routes/uninstall_token/index.ts | 6 ++- 16 files changed, 140 insertions(+), 107 deletions(-) diff --git a/x-pack/plugins/fleet/server/routes/agent/index.ts b/x-pack/plugins/fleet/server/routes/agent/index.ts index 1c40f36a7e481..cc1550fe24689 100644 --- a/x-pack/plugins/fleet/server/routes/agent/index.ts +++ b/x-pack/plugins/fleet/server/routes/agent/index.ts @@ -97,7 +97,8 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { readAgents: true }, }, - description: `Get agent by ID`, + summary: `Get an agent`, + description: `Get an agent by ID.`, options: { tags: ['oas-tag:Elastic Agents'], }, @@ -127,7 +128,8 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { allAgents: true }, }, - description: `Update agent by ID`, + summary: `Update an agent`, + description: `Update an agent by ID.`, options: { tags: ['oas-tag:Elastic Agents'], }, @@ -157,7 +159,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { allAgents: true }, }, - description: `Bulk update agent tags`, + summary: `Bulk update agent tags`, options: { tags: ['oas-tag:Elastic Agent actions'], }, @@ -187,7 +189,8 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { allAgents: true }, }, - description: `Delete agent by ID`, + summary: `Delete an agent`, + description: `Delete an agent by ID.`, options: { tags: ['oas-tag:Elastic Agents'], }, @@ -218,7 +221,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { readAgents: true }, }, - description: `List agents`, + summary: `Get agents`, options: { tags: ['oas-tag:Elastic Agents'], }, @@ -248,7 +251,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { readAgents: true }, }, - description: `List agent tags`, + summary: `Get agent tags`, options: { tags: ['oas-tag:Elastic Agents'], }, @@ -278,7 +281,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { allAgents: true }, }, - description: `Create agent action`, + summary: `Create an agent action`, options: { tags: ['oas-tag:Elastic Agent actions'], }, @@ -312,7 +315,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { allAgents: true }, }, - description: `Cancel agent action`, + summary: `Cancel an agent action`, options: { tags: ['oas-tag:Elastic Agent actions'], }, @@ -347,7 +350,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { readAgents: true }, }, - description: `List agents by action ids`, + summary: `Get agents by action ids`, options: { tags: ['oas-tag:Elastic Agents'], }, @@ -376,7 +379,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { allAgents: true }, }, - description: `Unenroll agent`, + summary: `Unenroll an agent`, options: { tags: ['oas-tag:Elastic Agent actions'], }, @@ -395,7 +398,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { allAgents: true }, }, - description: `Reassign agent`, + summary: `Reassign an agent`, options: { tags: ['oas-tag:Elastic Agent actions'], }, @@ -424,7 +427,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { readAgents: true }, }, - description: `Request agent diagnostics`, + summary: `Request agent diagnostics`, options: { tags: ['oas-tag:Elastic Agent actions'], }, @@ -453,7 +456,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { readAgents: true }, }, - description: `Bulk request diagnostics from agents`, + summary: `Bulk request diagnostics from agents`, options: { tags: ['oas-tag:Elastic Agent actions'], }, @@ -482,7 +485,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { readAgents: true }, }, - description: `List agent uploads`, + summary: `Get agent uploads`, options: { tags: ['oas-tag:Elastic Agents'], }, @@ -511,7 +514,8 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { readAgents: true }, }, - description: `Get file uploaded by agent`, + summary: `Get an uploaded file`, + description: `Get a file uploaded by an agent.`, options: { tags: ['oas-tag:Elastic Agents'], }, @@ -540,7 +544,8 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { allAgents: true }, }, - description: `Delete file uploaded by agent`, + summary: `Delete an uploaded file`, + description: `Delete a file uploaded by an agent.`, options: { tags: ['oas-tag:Elastic Agents'], }, @@ -572,7 +577,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz, getRouteRequiredAuthz('get', AGENT_API_ROUTES.STATUS_PATTERN) ).granted, - description: `Get agent status summary`, + summary: `Get an agent status summary`, options: { tags: ['oas-tag:Elastic Agent status'], }, @@ -601,7 +606,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { readAgents: true }, }, - description: `Get incoming agent data`, + summary: `Get incoming agent data`, options: { tags: ['oas-tag:Elastic Agents'], }, @@ -631,7 +636,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { allAgents: true }, }, - description: `Upgrade agent`, + summary: `Upgrade an agent`, options: { tags: ['oas-tag:Elastic Agent actions'], }, @@ -660,7 +665,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { allAgents: true }, }, - description: `Bulk upgrade agents`, + summary: `Bulk upgrade agents`, options: { tags: ['oas-tag:Elastic Agent actions'], }, @@ -690,7 +695,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { readAgents: true }, }, - description: `Get agent action status`, + summary: `Get an agent action status`, options: { tags: ['oas-tag:Elastic Agent actions'], }, @@ -720,7 +725,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { allAgents: true }, }, - description: `Bulk reassign agents`, + summary: `Bulk reassign agents`, options: { tags: ['oas-tag:Elastic Agent actions'], }, @@ -750,7 +755,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { allAgents: true }, }, - description: `Bulk unenroll agents`, + summary: `Bulk unenroll agents`, options: { tags: ['oas-tag:Elastic Agent actions'], }, @@ -780,7 +785,7 @@ export const registerAPIRoutes = (router: FleetAuthzRouter, config: FleetConfigT fleetAuthz: { fleet: { readAgents: true }, }, - description: `Get available agent versions`, + summary: `Get available agent versions`, options: { tags: ['oas-tag:Elastic Agents'], }, diff --git a/x-pack/plugins/fleet/server/routes/agent_policy/index.ts b/x-pack/plugins/fleet/server/routes/agent_policy/index.ts index 9311f0ae2acca..0d0dc6ae68c25 100644 --- a/x-pack/plugins/fleet/server/routes/agent_policy/index.ts +++ b/x-pack/plugins/fleet/server/routes/agent_policy/index.ts @@ -64,7 +64,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { // Allow to retrieve agent policies metadata (no full) for user with only read agents permissions return authz.fleet.readAgentPolicies || authz.fleet.readAgents; }, - description: `List agent policies`, + summary: `Get agent policies`, options: { tags: ['oas-tag:Elastic Agent policies'], }, @@ -95,7 +95,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { // Allow to retrieve agent policies metadata (no full) for user with only read agents permissions return authz.fleet.readAgentPolicies || authz.fleet.readAgents; }, - description: `Bulk get agent policies`, + summary: `Bulk get agent policies`, options: { tags: ['oas-tag:Elastic Agent policies'], }, @@ -126,7 +126,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { // Allow to retrieve agent policies metadata (no full) for user with only read agents permissions return authz.fleet.readAgentPolicies || authz.fleet.readAgents; }, - description: `Get an agent policy by ID`, + summary: `Get an agent policy`, + description: `Get an agent policy by ID.`, options: { tags: ['oas-tag:Elastic Agent policies'], }, @@ -156,7 +157,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allAgentPolicies: true }, }, - description: `Create an agent policy`, + summary: `Create an agent policy`, options: { tags: ['oas-tag:Elastic Agent policies'], }, @@ -186,7 +187,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allAgentPolicies: true }, }, - description: `Update an agent policy by ID`, + summary: `Update an agent policy`, + description: `Update an agent policy by ID.`, options: { tags: ['oas-tag:Elastic Agent policies'], }, @@ -216,7 +218,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allAgentPolicies: true }, }, - description: `Copy an agent policy by ID`, + summary: `Copy an agent policy`, + description: `Copy an agent policy by ID.`, options: { tags: ['oas-tag:Elastic Agent policies'], }, @@ -246,7 +249,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allAgentPolicies: true }, }, - description: `Delete agent policy by ID`, + summary: `Delete an agent policy`, + description: `Delete an agent policy by ID.`, options: { tags: ['oas-tag:Elastic Agent policies'], }, @@ -276,7 +280,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { readAgentPolicies: true }, }, - description: `Get a full agent policy by ID`, + summary: `Get a full agent policy`, + description: `Get a full agent policy by ID.`, options: { tags: ['oas-tag:Elastic Agent policies'], }, @@ -307,7 +312,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleet: { readAgentPolicies: true }, }, enableQueryVersion: true, - description: `Download an agent policy by ID`, + summary: `Download an agent policy`, + description: `Download an agent policy by ID.`, options: { tags: ['oas-tag:Elastic Agent policies'], }, @@ -340,7 +346,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { readAgentPolicies: true }, }, - description: `Get full K8s agent manifest`, + summary: `Get a full K8s agent manifest`, options: { tags: ['oas-tag:Elastic Agent policies'], }, @@ -371,7 +377,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleet: { readAgentPolicies: true }, }, enableQueryVersion: true, - description: ``, + summary: `Download an agent manifest`, options: { tags: ['oas-tag:Elastic Agent policies'], }, @@ -403,7 +409,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: (authz) => { return authz.fleet.readAgentPolicies && authz.fleet.readSettings; }, - description: `Get list of outputs associated with agent policies`, + summary: `Get outputs for agent policies`, + description: `Get a list of outputs associated with agent policies.`, options: { tags: ['oas-tag:Elastic Agent policies'], }, @@ -432,7 +439,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: (authz) => { return authz.fleet.readAgentPolicies && authz.fleet.readSettings; }, - description: `Get list of outputs associated with agent policy by policy id`, + summary: `Get outputs for an agent policy`, + description: `Get a list of outputs associated with agent policy by policy id.`, options: { tags: ['oas-tag:Elastic Agent policies'], }, diff --git a/x-pack/plugins/fleet/server/routes/app/index.ts b/x-pack/plugins/fleet/server/routes/app/index.ts index e66f9f02a687b..db7eddd5ddd45 100644 --- a/x-pack/plugins/fleet/server/routes/app/index.ts +++ b/x-pack/plugins/fleet/server/routes/app/index.ts @@ -218,7 +218,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType router.versioned .get({ path: APP_API_ROUTES.CHECK_PERMISSIONS_PATTERN, - description: `Check permissions`, + summary: `Check permissions`, options: { tags: ['oas-tag:Fleet internals'], }, @@ -263,7 +263,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType fleetAuthz: { fleet: { allAgents: true }, }, - description: `Create a service token`, + summary: `Create a service token`, options: { tags: ['oas-tag:Fleet service tokens'], }, diff --git a/x-pack/plugins/fleet/server/routes/data_streams/index.ts b/x-pack/plugins/fleet/server/routes/data_streams/index.ts index a20b893717fdc..7dc870c394bc8 100644 --- a/x-pack/plugins/fleet/server/routes/data_streams/index.ts +++ b/x-pack/plugins/fleet/server/routes/data_streams/index.ts @@ -52,7 +52,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { all: true }, }, - description: `List data streams`, + summary: `Get data streams`, options: { tags: ['oas-tag:Data streams'], }, diff --git a/x-pack/plugins/fleet/server/routes/download_source/index.ts b/x-pack/plugins/fleet/server/routes/download_source/index.ts index 83059593730db..687fdcf5f793f 100644 --- a/x-pack/plugins/fleet/server/routes/download_source/index.ts +++ b/x-pack/plugins/fleet/server/routes/download_source/index.ts @@ -39,7 +39,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: (authz) => { return authz.fleet.readSettings || authz.fleet.readAgentPolicies; }, - description: `List agent binary download sources`, + summary: `Get agent binary download sources`, options: { tags: ['oas-tag:Elastic Agent binary download sources'], }, @@ -68,7 +68,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: (authz) => { return authz.fleet.readSettings || authz.fleet.readAgentPolicies; }, - description: `Get agent binary download source by ID`, + summary: `Get an agent binary download source`, + description: `Get an agent binary download source by ID.`, options: { tags: ['oas-tag:Elastic Agent binary download sources'], }, @@ -97,7 +98,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allSettings: true }, }, - description: `Update agent binary download source by ID`, + summary: `Update an agent binary download source`, + description: `Update an agent binary download source by ID.`, options: { tags: ['oas-tag:Elastic Agent binary download sources'], }, @@ -126,7 +128,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allSettings: true }, }, - description: `Create agent binary download source`, + summary: `Create an agent binary download source`, options: { tags: ['oas-tag:Elastic Agent binary download sources'], }, @@ -155,7 +157,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allSettings: true }, }, - description: `Delete agent binary download source by ID`, + summary: `Delete an agent binary download source`, + description: `Delete an agent binary download source by ID.`, options: { tags: ['oas-tag:Elastic Agent binary download sources'], }, diff --git a/x-pack/plugins/fleet/server/routes/enrollment_api_key/index.ts b/x-pack/plugins/fleet/server/routes/enrollment_api_key/index.ts index bc6c61dc8ffe4..58538ba18f359 100644 --- a/x-pack/plugins/fleet/server/routes/enrollment_api_key/index.ts +++ b/x-pack/plugins/fleet/server/routes/enrollment_api_key/index.ts @@ -39,7 +39,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { readEnrollmentTokens: true }, }, - description: `Get enrollment API key by ID`, + summary: `Get an enrollment API key`, + description: `Get an enrollment API key by ID.`, options: { tags: ['oas-tag:Fleet enrollment API keys'], }, @@ -68,7 +69,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allAgents: true }, }, - description: `Revoke enrollment API key by ID by marking it as inactive`, + summary: `Revoke an enrollment API key`, + description: `Revoke an enrollment API key by ID by marking it as inactive.`, options: { tags: ['oas-tag:Fleet enrollment API keys'], }, @@ -97,7 +99,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { readEnrollmentTokens: true }, }, - description: `List enrollment API keys`, + summary: `Get enrollment API keys`, options: { tags: ['oas-tag:Fleet enrollment API keys'], }, @@ -126,7 +128,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allAgents: true }, }, - description: `Create enrollment API key`, + summary: `Create an enrollment API key`, options: { tags: ['oas-tag:Fleet enrollment API keys'], }, diff --git a/x-pack/plugins/fleet/server/routes/epm/index.ts b/x-pack/plugins/fleet/server/routes/epm/index.ts index 283f8d6a1b0a0..787b02b69c3e8 100644 --- a/x-pack/plugins/fleet/server/routes/epm/index.ts +++ b/x-pack/plugins/fleet/server/routes/epm/index.ts @@ -102,7 +102,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType .get({ path: EPM_API_ROUTES.CATEGORIES_PATTERN, fleetAuthz: READ_PACKAGE_INFO_AUTHZ, - description: `List package categories`, + summary: `Get package categories`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, @@ -129,7 +129,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType .get({ path: EPM_API_ROUTES.LIST_PATTERN, fleetAuthz: READ_PACKAGE_INFO_AUTHZ, - description: `List packages`, + summary: `Get packages`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, @@ -156,7 +156,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType .get({ path: EPM_API_ROUTES.INSTALLED_LIST_PATTERN, fleetAuthz: READ_PACKAGE_INFO_AUTHZ, - description: `Get installed packages`, + summary: `Get installed packages`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, @@ -183,7 +183,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType .get({ path: EPM_API_ROUTES.LIMITED_LIST_PATTERN, fleetAuthz: READ_PACKAGE_INFO_AUTHZ, - description: `Get limited package list`, + summary: `Get a limited package list`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, @@ -210,7 +210,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType .get({ path: EPM_API_ROUTES.STATS_PATTERN, fleetAuthz: READ_PACKAGE_INFO_AUTHZ, - description: `Get package stats`, + summary: `Get package stats`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, @@ -237,7 +237,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType .get({ path: EPM_API_ROUTES.INPUTS_PATTERN, fleetAuthz: READ_PACKAGE_INFO_AUTHZ, - description: `Get inputs template`, + summary: `Get an inputs template`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, @@ -264,7 +264,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType .get({ path: EPM_API_ROUTES.FILEPATH_PATTERN, fleetAuthz: READ_PACKAGE_INFO_AUTHZ, - description: `Get package file`, + summary: `Get a package file`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, @@ -293,7 +293,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType fleetAuthz: (fleetAuthz: FleetAuthz): boolean => calculateRouteAuthz(fleetAuthz, getRouteRequiredAuthz('get', EPM_API_ROUTES.INFO_PATTERN)) .granted, - description: `Get package`, + summary: `Get a package`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, @@ -322,7 +322,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType fleetAuthz: { integrations: { writePackageSettings: true }, }, - description: `Update package settings`, + summary: `Update package settings`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, @@ -349,7 +349,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType .post({ path: EPM_API_ROUTES.INSTALL_FROM_REGISTRY_PATTERN, fleetAuthz: INSTALL_PACKAGES_AUTHZ, - description: `Install package from registry`, + summary: `Install a package from the registry`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, @@ -379,7 +379,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType fleetAuthz: { integrations: { installPackages: true }, }, - description: `Install Kibana assets for package`, + summary: `Install Kibana assets for a package`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, @@ -408,7 +408,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType fleetAuthz: { integrations: { installPackages: true }, }, - description: `Delete Kibana assets for package`, + summary: `Delete Kibana assets for a package`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, @@ -438,7 +438,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType fleetAuthz: { integrations: { installPackages: true, upgradePackages: true }, }, - description: `Bulk install packages`, + summary: `Bulk install packages`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, @@ -476,7 +476,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType fleetAuthz: { integrations: { uploadPackages: true }, }, - description: `Install package by upload`, + summary: `Install a package by upload`, }) .addVersion( { @@ -500,7 +500,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType .post({ path: EPM_API_ROUTES.CUSTOM_INTEGRATIONS_PATTERN, fleetAuthz: INSTALL_PACKAGES_AUTHZ, - description: `Create custom integration`, + summary: `Create a custom integration`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, @@ -529,7 +529,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType fleetAuthz: { integrations: { removePackages: true }, }, - description: `Delete package`, + summary: `Delete a package`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, @@ -557,7 +557,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType .get({ path: EPM_API_ROUTES.VERIFICATION_KEY_ID, fleetAuthz: READ_PACKAGE_INFO_AUTHZ, - description: `Get a package signature verification key ID`, + summary: `Get a package signature verification key ID`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, @@ -584,7 +584,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType .get({ path: EPM_API_ROUTES.DATA_STREAMS_PATTERN, fleetAuthz: READ_PACKAGE_INFO_AUTHZ, - description: `List data streams`, + summary: `Get data streams`, options: { tags: ['oas-tag:Data streams'], }, @@ -611,7 +611,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType .post({ path: EPM_API_ROUTES.BULK_ASSETS_PATTERN, fleetAuthz: READ_PACKAGE_INFO_AUTHZ, - description: `Bulk get assets`, + summary: `Bulk get assets`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, @@ -651,7 +651,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType }, }, }, - description: `Authorize transforms`, + summary: `Authorize transforms`, options: { tags: ['oas-tag:Elastic Package Manager (EPM)'], }, diff --git a/x-pack/plugins/fleet/server/routes/fleet_proxies/index.ts b/x-pack/plugins/fleet/server/routes/fleet_proxies/index.ts index 54eba070dd8e1..1a5ad6ccc764d 100644 --- a/x-pack/plugins/fleet/server/routes/fleet_proxies/index.ts +++ b/x-pack/plugins/fleet/server/routes/fleet_proxies/index.ts @@ -37,7 +37,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { readSettings: true }, }, - description: `List proxies`, + summary: `Get proxies`, options: { tags: ['oas-tag:Fleet proxies'], }, @@ -66,7 +66,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allSettings: true }, }, - description: `Create proxy`, + summary: `Create a proxy`, options: { tags: ['oas-tag:Fleet proxies'], }, @@ -95,7 +95,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allSettings: true }, }, - description: `Update proxy by ID`, + summary: `Update a proxy`, + description: `Update a proxy by ID.`, options: { tags: ['oas-tag:Fleet proxies'], }, @@ -124,7 +125,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { readSettings: true }, }, - description: `Get proxy by ID`, + summary: `Get a proxy`, + description: `Get a proxy by ID.`, options: { tags: ['oas-tag:Fleet proxies'], }, @@ -153,7 +155,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allSettings: true }, }, - description: `Delete proxy by ID`, + summary: `Delete a proxy`, + description: `Delete a proxy by ID`, options: { tags: ['oas-tag:Fleet proxies'], }, diff --git a/x-pack/plugins/fleet/server/routes/fleet_server_hosts/index.ts b/x-pack/plugins/fleet/server/routes/fleet_server_hosts/index.ts index 0a79e9ae11649..667a617659492 100644 --- a/x-pack/plugins/fleet/server/routes/fleet_server_hosts/index.ts +++ b/x-pack/plugins/fleet/server/routes/fleet_server_hosts/index.ts @@ -39,7 +39,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: (authz) => { return authz.fleet.addAgents || authz.fleet.addFleetServers || authz.fleet.readSettings; }, - description: `List Fleet Server hosts`, + summary: `Get Fleet Server hosts`, options: { tags: ['oas-tag:Fleet Server hosts'], }, @@ -67,7 +67,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allSettings: true }, }, - description: `Create Fleet Server host`, + summary: `Create a Fleet Server host`, options: { tags: ['oas-tag:Fleet Server hosts'], }, @@ -95,7 +95,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { readSettings: true }, }, - description: `Get Fleet Server host by ID`, + summary: `Get a Fleet Server host`, + description: `Get a Fleet Server host by ID.`, options: { tags: ['oas-tag:Fleet Server hosts'], }, @@ -123,7 +124,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allSettings: true }, }, - description: `Delete Fleet Server host by ID`, + summary: `Delete a Fleet Server host`, + description: `Delete a Fleet Server host by ID.`, options: { tags: ['oas-tag:Fleet Server hosts'], }, @@ -154,7 +156,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allSettings: true }, }, - description: `Update Fleet Server host by ID`, + summary: `Update a Fleet Server host`, + description: `Update a Fleet Server host by ID.`, options: { tags: ['oas-tag:Fleet Server hosts'], }, diff --git a/x-pack/plugins/fleet/server/routes/health_check/index.ts b/x-pack/plugins/fleet/server/routes/health_check/index.ts index 3b06526b62d14..008340d006829 100644 --- a/x-pack/plugins/fleet/server/routes/health_check/index.ts +++ b/x-pack/plugins/fleet/server/routes/health_check/index.ts @@ -22,7 +22,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allSettings: true }, }, - description: `Check Fleet Server health`, + summary: `Check Fleet Server health`, options: { tags: ['oas-tag:Fleet internals'], }, diff --git a/x-pack/plugins/fleet/server/routes/message_signing_service/index.ts b/x-pack/plugins/fleet/server/routes/message_signing_service/index.ts index 4e78b3228df5a..645e7070f901a 100644 --- a/x-pack/plugins/fleet/server/routes/message_signing_service/index.ts +++ b/x-pack/plugins/fleet/server/routes/message_signing_service/index.ts @@ -23,7 +23,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { all: true }, }, - description: 'Rotate fleet message signing key pair', + summary: 'Rotate a Fleet message signing key pair', options: { tags: ['oas-tag:Message Signing Service'], }, diff --git a/x-pack/plugins/fleet/server/routes/output/index.ts b/x-pack/plugins/fleet/server/routes/output/index.ts index c9d5b6acdd7d3..dd89eaabf396b 100644 --- a/x-pack/plugins/fleet/server/routes/output/index.ts +++ b/x-pack/plugins/fleet/server/routes/output/index.ts @@ -43,7 +43,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: (authz) => { return authz.fleet.readSettings || authz.fleet.readAgentPolicies; }, - description: 'List outputs', + summary: 'Get outputs', options: { tags: ['oas-tag:Fleet outputs'], }, @@ -71,7 +71,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: (authz) => { return authz.fleet.readSettings || authz.fleet.readAgentPolicies; }, - description: 'Get output by ID', + summary: 'Get output', + description: 'Get output by ID.', options: { tags: ['oas-tag:Fleet outputs'], }, @@ -99,7 +100,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: (authz) => { return authz.fleet.allSettings || authz.fleet.allAgentPolicies; }, - description: 'Update output by ID', + summary: 'Update output', + description: 'Update output by ID.', options: { tags: ['oas-tag:Fleet outputs'], }, @@ -128,7 +130,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allSettings: true }, }, - description: 'Create output', + summary: 'Create output', options: { tags: ['oas-tag:Fleet outputs'], }, @@ -157,7 +159,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allSettings: true }, }, - description: 'Delete output by ID', + summary: 'Delete output', + description: 'Delete output by ID.', options: { tags: ['oas-tag:Fleet outputs'], }, @@ -189,7 +192,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { allSettings: true }, }, - description: 'Generate Logstash API key', + summary: 'Generate a Logstash API key', options: { tags: ['oas-tag:Fleet outputs'], }, @@ -218,7 +221,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { readSettings: true }, }, - description: 'Get latest output health', + summary: 'Get the latest output health', options: { tags: ['oas-tag:Fleet outputs'], }, diff --git a/x-pack/plugins/fleet/server/routes/package_policy/index.ts b/x-pack/plugins/fleet/server/routes/package_policy/index.ts index 86ac38e658ee3..8a547f4127f97 100644 --- a/x-pack/plugins/fleet/server/routes/package_policy/index.ts +++ b/x-pack/plugins/fleet/server/routes/package_policy/index.ts @@ -61,7 +61,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz, getRouteRequiredAuthz('get', PACKAGE_POLICY_API_ROUTES.LIST_PATTERN) ).granted, - description: 'List package policies', + summary: 'Get package policies', options: { tags: ['oas-tag:Fleet package policies'], }, @@ -93,7 +93,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz, getRouteRequiredAuthz('post', PACKAGE_POLICY_API_ROUTES.BULK_GET_PATTERN) ).granted, - description: 'Bulk get package policies', + summary: 'Bulk get package policies', options: { tags: ['oas-tag:Fleet package policies'], }, @@ -128,7 +128,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz, getRouteRequiredAuthz('get', PACKAGE_POLICY_API_ROUTES.INFO_PATTERN) ).granted, - description: 'Get package policy by ID', + summary: 'Get a package policy', + description: 'Get a package policy by ID.', options: { tags: ['oas-tag:Fleet package policies'], }, @@ -187,7 +188,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { router.versioned .post({ path: PACKAGE_POLICY_API_ROUTES.CREATE_PATTERN, - description: 'Create package policy', + summary: 'Create a package policy', options: { tags: ['oas-tag:Fleet package policies'], }, @@ -222,7 +223,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz, getRouteRequiredAuthz('put', PACKAGE_POLICY_API_ROUTES.UPDATE_PATTERN) ).granted, - description: 'Update package policy by ID', + summary: 'Update a package policy', + description: 'Update a package policy by ID.', options: { tags: ['oas-tag:Fleet package policies'], }, @@ -259,7 +261,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { integrations: { writeIntegrationPolicies: true }, }, - description: 'Bulk delete package policies', + summary: 'Bulk delete package policies', options: { tags: ['oas-tag:Fleet package policies'], }, @@ -288,7 +290,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { integrations: { writeIntegrationPolicies: true }, }, - description: 'Delete package policy by ID', + summary: 'Delete a package policy', + description: 'Delete a package policy by ID.', options: { tags: ['oas-tag:Fleet package policies'], }, @@ -318,7 +321,8 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { integrations: { writeIntegrationPolicies: true }, }, - description: 'Upgrade package policy to a newer package version', + summary: 'Upgrade a package policy', + description: 'Upgrade a package policy to a newer package version.', options: { tags: ['oas-tag:Fleet package policies'], }, @@ -348,7 +352,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => { fleetAuthz: { integrations: { readIntegrationPolicies: true }, }, - description: 'Dry run package policy upgrade', + summary: 'Dry run a package policy upgrade', options: { tags: ['oas-tag:Fleet package policies'], }, diff --git a/x-pack/plugins/fleet/server/routes/settings/index.ts b/x-pack/plugins/fleet/server/routes/settings/index.ts index b101937e45c27..04e6c2a955634 100644 --- a/x-pack/plugins/fleet/server/routes/settings/index.ts +++ b/x-pack/plugins/fleet/server/routes/settings/index.ts @@ -45,7 +45,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType authz.fleet.allAgentPolicies ); }, - description: `Get space settings`, + summary: `Get space settings`, }) .addVersion( { @@ -68,7 +68,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType fleetAuthz: { fleet: { allSettings: true }, }, - description: `Put space settings`, + summary: `Create space settings`, }) .addVersion( { @@ -92,7 +92,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType fleetAuthz: { fleet: { readSettings: true }, }, - description: `Get settings`, + summary: `Get settings`, options: { tags: ['oas-tag:Fleet internals'], }, @@ -123,7 +123,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType fleetAuthz: { fleet: { allSettings: true }, }, - description: `Update settings`, + summary: `Update settings`, options: { tags: ['oas-tag:Fleet internals'], }, @@ -154,7 +154,7 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType fleetAuthz: (authz) => { return authz.fleet.addAgents || authz.fleet.addFleetServers; }, - description: `Get enrollment settings`, + summary: `Get enrollment settings`, options: { tags: ['oas-tag:Fleet internals'], }, diff --git a/x-pack/plugins/fleet/server/routes/setup/index.ts b/x-pack/plugins/fleet/server/routes/setup/index.ts index 4b6fd2316832d..2f41ff7eb6878 100644 --- a/x-pack/plugins/fleet/server/routes/setup/index.ts +++ b/x-pack/plugins/fleet/server/routes/setup/index.ts @@ -42,7 +42,7 @@ export const registerFleetSetupRoute = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { setup: true }, }, - description: `Initiate Fleet setup`, + summary: `Initiate Fleet setup`, options: { tags: ['oas-tag:Fleet internals'], }, @@ -104,7 +104,7 @@ export const registerCreateFleetSetupRoute = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { setup: true }, }, - description: `Initiate agent setup`, + summary: `Initiate agent setup`, options: { tags: ['oas-tag:Elastic Agents'], }, @@ -135,7 +135,7 @@ export const registerGetFleetStatusRoute = (router: FleetAuthzRouter) => { fleetAuthz: { fleet: { setup: true }, }, - description: `Get agent setup info`, + summary: `Get agent setup info`, options: { tags: ['oas-tag:Elastic Agents'], }, diff --git a/x-pack/plugins/fleet/server/routes/uninstall_token/index.ts b/x-pack/plugins/fleet/server/routes/uninstall_token/index.ts index a90dd678e99dd..3c5e25d414b27 100644 --- a/x-pack/plugins/fleet/server/routes/uninstall_token/index.ts +++ b/x-pack/plugins/fleet/server/routes/uninstall_token/index.ts @@ -31,7 +31,8 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType fleetAuthz: { fleet: { allAgents: true }, }, - description: 'List metadata for latest uninstall tokens per agent policy', + summary: 'Get metadata for latest uninstall tokens', + description: 'List the metadata for the latest uninstall tokens per agent policy.', options: { tags: ['oas-tag:Fleet uninstall tokens'], }, @@ -60,7 +61,8 @@ export const registerRoutes = (router: FleetAuthzRouter, config: FleetConfigType fleetAuthz: { fleet: { allAgents: true }, }, - description: 'Get one decrypted uninstall token by its ID', + summary: 'Get a decrypted uninstall token', + description: 'Get one decrypted uninstall token by its ID.', options: { tags: ['oas-tag:Fleet uninstall tokens'], },