From 8620440b27d75104486263d86d02fa53b5b6f272 Mon Sep 17 00:00:00 2001
From: CJ Cenizal <cj@cenizal.com>
Date: Fri, 1 Oct 2021 14:47:44 -0700
Subject: [PATCH] Add note about intended use case of status API route.

---
 x-pack/plugins/upgrade_assistant/server/routes/status.ts | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/x-pack/plugins/upgrade_assistant/server/routes/status.ts b/x-pack/plugins/upgrade_assistant/server/routes/status.ts
index aef97dcb7bd715b..ce9bb2e1c55d05c 100644
--- 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(
     {