[HTTP/OAS] Add Fleet API descriptions (#184613)

elastic · Jun 3, 2024 · 74ae374 · 74ae374
1 parent ce97741
commit 74ae374
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 0 deletions.
diff --git a/x-pack/plugins/fleet/server/routes/agent_policy/index.ts b/x-pack/plugins/fleet/server/routes/agent_policy/index.ts
@@ -47,6 +47,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: `Get agent policies`,
     })
     .addVersion(
       {
@@ -80,6 +81,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: `Get an agent policy by ID`,
     })
     .addVersion(
       {
@@ -96,6 +98,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
       fleetAuthz: {
         fleet: { allAgentPolicies: true },
       },
+      description: `Create an agent policy`,
     })
     .addVersion(
       {
@@ -112,6 +115,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
       fleetAuthz: {
         fleet: { allAgentPolicies: true },
       },
+      description: `Update an agent policy by ID`,
     })
     .addVersion(
       {
@@ -128,6 +132,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
       fleetAuthz: {
         fleet: { allAgentPolicies: true },
       },
+      description: `Copy an agent policy by ID`,
     })
     .addVersion(
       {
@@ -160,6 +165,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
       fleetAuthz: {
         fleet: { readAgentPolicies: true },
       },
+      description: `Get a full agent policy by ID`,
     })
     .addVersion(
       {
@@ -177,6 +183,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
         fleet: { readAgentPolicies: true },
       },
       enableQueryVersion: true,
+      description: `Download an agent policy by ID`,
     })
     .addVersion(
       {
@@ -193,6 +200,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
       fleetAuthz: {
         fleet: { readAgentPolicies: true },
       },
+      description: `Get full K8s agent manifest`,
     })
     .addVersion(
       {

diff --git a/x-pack/plugins/fleet/server/routes/app/index.ts b/x-pack/plugins/fleet/server/routes/app/index.ts
@@ -158,6 +158,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
       fleetAuthz: {
         fleet: { allAgents: true },
       },
+      description: `Create a service token`,
     })
     .addVersion(
       {
@@ -175,6 +176,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
       fleetAuthz: {
         fleet: { allAgents: true },
       },
+      description: `Create a service token`,
     })
     .addVersion(
       {

diff --git a/x-pack/plugins/fleet/server/routes/epm/index.ts b/x-pack/plugins/fleet/server/routes/epm/index.ts
@@ -86,6 +86,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
     .get({
       path: EPM_API_ROUTES.CATEGORIES_PATTERN,
       fleetAuthz: READ_PACKAGE_INFO_AUTHZ,
+      description: `Get package categories`,
     })
     .addVersion(
       {
@@ -99,6 +100,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
     .get({
       path: EPM_API_ROUTES.LIST_PATTERN,
       fleetAuthz: READ_PACKAGE_INFO_AUTHZ,
+      description: `Get list of packages`,
     })
     .addVersion(
       {
@@ -125,6 +127,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
     .get({
       path: EPM_API_ROUTES.LIMITED_LIST_PATTERN,
       fleetAuthz: READ_PACKAGE_INFO_AUTHZ,
+      description: `Get limited package list`,
     })
     .addVersion(
       {
@@ -287,6 +290,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
     .get({
       path: EPM_API_ROUTES.VERIFICATION_KEY_ID,
       fleetAuthz: READ_PACKAGE_INFO_AUTHZ,
+      description: `Get a package signature verification key ID`,
     })
     .addVersion(
       {
@@ -313,6 +317,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
     .post({
       path: EPM_API_ROUTES.BULK_ASSETS_PATTERN,
       fleetAuthz: READ_PACKAGE_INFO_AUTHZ,
+      description: `Get bulk assets`,
     })
     .addVersion(
       {

diff --git a/x-pack/plugins/fleet/server/routes/health_check/index.ts b/x-pack/plugins/fleet/server/routes/health_check/index.ts
@@ -25,6 +25,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
       fleetAuthz: {
         fleet: { all: true },
       },
+      description: `Check Fleet Server health`,
     })
     .addVersion(
       {

diff --git a/x-pack/plugins/fleet/server/routes/settings/index.ts b/x-pack/plugins/fleet/server/routes/settings/index.ts
@@ -78,6 +78,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
       fleetAuthz: {
         fleet: { readSettings: true },
       },
+      description: `Get settings`,
     })
     .addVersion(
       {
@@ -92,6 +93,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
       fleetAuthz: {
         fleet: { allSettings: true },
       },
+      description: `Update settings`,
     })
     .addVersion(
       {
@@ -106,6 +108,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
       fleetAuthz: (authz) => {
         return authz.fleet.addAgents || authz.fleet.addFleetServers;
       },
+      description: `Get enrollment settings`,
     })
     .addVersion(
       {

diff --git a/x-pack/plugins/fleet/server/routes/setup/index.ts b/x-pack/plugins/fleet/server/routes/setup/index.ts
@@ -21,6 +21,7 @@ export const registerFleetSetupRoute = (router: FleetAuthzRouter) => {
       fleetAuthz: {
         fleet: { setup: true },
       },
+      description: `Initiate Fleet setup`,
     })
     .addVersion(
       {