From 043cf88a63200553eb2233b6fc0d353e7d166094 Mon Sep 17 00:00:00 2001
From: Jamie Klassen <jamie.klassen@broadcom.com>
Date: Mon, 22 Jan 2024 10:41:29 -0500
Subject: [PATCH] add title field to ClusterDetails

Signed-off-by: Jamie Klassen <jamie.klassen@broadcom.com>
---
 .changeset/sixty-bags-fry.md               | 6 ++++++
 plugins/kubernetes-node/api-report.md      | 1 +
 plugins/kubernetes-node/src/types/types.ts | 6 +++++-
 3 files changed, 12 insertions(+), 1 deletion(-)
 create mode 100644 .changeset/sixty-bags-fry.md

diff --git a/.changeset/sixty-bags-fry.md b/.changeset/sixty-bags-fry.md
new file mode 100644
index 0000000000..139e31c6a4
--- /dev/null
+++ b/.changeset/sixty-bags-fry.md
@@ -0,0 +1,6 @@
+---
+'@backstage/plugin-kubernetes-node': patch
+---
+
+The `ClusterDetails` type now has a `title` field, which should be a
+human-readable name.
diff --git a/plugins/kubernetes-node/api-report.md b/plugins/kubernetes-node/api-report.md
index 0521ed72aa..509416fa4a 100644
--- a/plugins/kubernetes-node/api-report.md
+++ b/plugins/kubernetes-node/api-report.md
@@ -51,6 +51,7 @@ export interface ClusterDetails {
   skipMetricsLookup?: boolean;
   // (undocumented)
   skipTLSVerify?: boolean;
+  title?: string;
   // (undocumented)
   url: string;
 }
diff --git a/plugins/kubernetes-node/src/types/types.ts b/plugins/kubernetes-node/src/types/types.ts
index 2881338868..665b06178a 100644
--- a/plugins/kubernetes-node/src/types/types.ts
+++ b/plugins/kubernetes-node/src/types/types.ts
@@ -67,9 +67,13 @@ export type AuthMetadata = Record<string, string>;
  */
 export interface ClusterDetails {
   /**
-   * Specifies the name of the Kubernetes cluster.
+   * Name of the Kubernetes cluster; used as an internal identifier.
    */
   name: string;
+  /**
+   * Human-readable name for the cluster, to be dispayed in UIs.
+   */
+  title?: string;
   url: string;
   authMetadata: AuthMetadata;
   skipTLSVerify?: boolean;