From a643af8082d6369147fabf886b471c52ed506fce Mon Sep 17 00:00:00 2001 From: Jamie Klassen Date: Mon, 22 Jan 2024 11:24:14 -0500 Subject: [PATCH] add title to ClusterAttributes Signed-off-by: Jamie Klassen --- .changeset/healthy-bees-deliver.md | 5 +++++ plugins/kubernetes-common/api-report.md | 1 + plugins/kubernetes-common/src/types.ts | 6 +++++- 3 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 .changeset/healthy-bees-deliver.md diff --git a/.changeset/healthy-bees-deliver.md b/.changeset/healthy-bees-deliver.md new file mode 100644 index 0000000000..80da17dc0b --- /dev/null +++ b/.changeset/healthy-bees-deliver.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-kubernetes-common': patch +--- + +The `ClusterAttributes` type now includes the cluster title. diff --git a/plugins/kubernetes-common/api-report.md b/plugins/kubernetes-common/api-report.md index e4dbf79f4a..c1d399b196 100644 --- a/plugins/kubernetes-common/api-report.md +++ b/plugins/kubernetes-common/api-report.md @@ -112,6 +112,7 @@ export interface ClusterAttributes { dashboardParameters?: JsonObject; dashboardUrl?: string; name: string; + title?: string; } // @public (undocumented) diff --git a/plugins/kubernetes-common/src/types.ts b/plugins/kubernetes-common/src/types.ts index c9a4ce4c5a..cd316af089 100644 --- a/plugins/kubernetes-common/src/types.ts +++ b/plugins/kubernetes-common/src/types.ts @@ -67,9 +67,13 @@ export interface KubernetesRequestBody { /** @public */ export interface ClusterAttributes { /** - * 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; /** * Specifies the link to the Kubernetes dashboard managing this cluster. * @remarks