[HTTP/OAS] Add descriptions for upgrade assistant APIs (#184269)

elastic · May 28, 2024 · e595d28 · e595d28
1 parent a9c8e8f
commit e595d28
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/x-pack/plugins/upgrade_assistant/server/routes/reindex_indices/batch_reindex_indices.ts b/x-pack/plugins/upgrade_assistant/server/routes/reindex_indices/batch_reindex_indices.ts
@@ -36,6 +36,10 @@ export function registerBatchReindexIndicesRoutes(
   router.get(
     {
       path: `${BASE_PATH}/batch/queue`,
+      options: {
+        access: 'public',
+        description: `Get the batch reindex queue`,
+      },
       validate: {},
     },
     versionCheckHandlerWrapper(async ({ core }, request, response) => {
@@ -71,6 +75,10 @@ export function registerBatchReindexIndicesRoutes(
   router.post(
     {
       path: `${BASE_PATH}/batch`,
+      options: {
+        access: 'public',
+        description: `Batch start or resume reindex`,
+      },
       validate: {
         body: schema.object({
           indexNames: schema.arrayOf(schema.string()),

diff --git a/x-pack/plugins/upgrade_assistant/server/routes/reindex_indices/reindex_indices.ts b/x-pack/plugins/upgrade_assistant/server/routes/reindex_indices/reindex_indices.ts
@@ -34,6 +34,10 @@ export function registerReindexIndicesRoutes(
   router.post(
     {
       path: `${BASE_PATH}/{indexName}`,
+      options: {
+        access: 'public',
+        description: `Start or resume reindex`,
+      },
       validate: {
         params: schema.object({
           indexName: schema.string(),
@@ -77,6 +81,10 @@ export function registerReindexIndicesRoutes(
   router.get(
     {
       path: `${BASE_PATH}/{indexName}`,
+      options: {
+        access: 'public',
+        description: `Get reindex status`,
+      },
       validate: {
         params: schema.object({
           indexName: schema.string(),
@@ -134,6 +142,10 @@ export function registerReindexIndicesRoutes(
   router.post(
     {
       path: `${BASE_PATH}/{indexName}/cancel`,
+      options: {
+        access: 'public',
+        description: `Cancel reindex`,
+      },
       validate: {
         params: schema.object({
           indexName: schema.string(),

diff --git a/x-pack/plugins/upgrade_assistant/server/routes/status.ts b/x-pack/plugins/upgrade_assistant/server/routes/status.ts
@@ -24,6 +24,10 @@ export function registerUpgradeStatusRoute({
   router.get(
     {
       path: `${API_BASE_PATH}/status`,
+      options: {
+        access: 'public',
+        description: `Get upgrade readiness status`,
+      },
       validate: false,
     },
     versionCheckHandlerWrapper(async ({ core }, request, response) => {