Add note about intended use case of status API route.

elastic · Oct 4, 2021 · 0c9b2c7 · 0c9b2c7
1 parent 9dad43e
commit 0c9b2c7
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/x-pack/plugins/upgrade_assistant/server/routes/status.ts b/x-pack/plugins/upgrade_assistant/server/routes/status.ts
@@ -12,6 +12,9 @@ import { versionCheckHandlerWrapper } from '../lib/es_version_precheck';
 import { getKibanaUpgradeStatus } from '../lib/kibana_status';
 import { RouteDependencies } from '../types';
 
+/**
+ * Note that this route is primarily intended for consumption by Cloud.
+ */
 export function registerUpgradeStatusRoute({ router, lib: { handleEsError } }: RouteDependencies) {
   router.get(
     {