Merge pull request #5875 from backstage/rugvip/config-cleanup

Updated config schema to use Array<> for multiline blocks + core wording tweaks

packages/core-app-api/config.d.ts

@@ -26,7 +26,7 @@ export interface Config {
     baseUrl: string;
 
     /**
-     * The title of the app.
+     * The title of the app, as shown in the Backstage web interface.
      * @visibility frontend
      */
     title?: string;
@@ -43,7 +43,7 @@ export interface Config {
       /**
        * A list of categorized support item groupings.
        */
-      items: {
+      items: Array<{
         /**
          * The title of the support item grouping.
          * @visibility frontend
@@ -55,15 +55,15 @@ export interface Config {
          */
         icon?: string;
         /**
-         * A list of support links for the Backstage instance.
+         * A list of support links for the Backstage instance inside this grouping.
          */
-        links: {
+        links: Array<{
           /** @visibility frontend */
           url: string;
           /** @visibility frontend */
           title?: string;
-        }[];
-      }[];
+        }>;
+      }>;
     };
   };
 
@@ -72,7 +72,7 @@ export interface Config {
    */
   backend: {
     /**
-     * The public absolute root URL that the backend is reachable at.
+     * The public absolute root URL that the backend is reachable at, from the browser's perspective.
      * @visibility frontend
      */
     baseUrl: string;
@@ -90,16 +90,16 @@ export interface Config {
   };
 
   homepage?: {
-    clocks?: {
+    clocks?: Array<{
       /** @visibility frontend */
       label: string;
       /** @visibility frontend */
       timezone: string;
-    }[];
+    }>;
   };
 
   /**
-   * Configuration that provides information on available authentication providers configured for app
+   * Configuration that provides information on available configured authentication providers.
    */
   auth?: {
     /**

packages/core/config.d.ts

@@ -26,7 +26,7 @@ export interface Config {
     baseUrl: string;
 
     /**
-     * The title of the app.
+     * The title of the app, as shown in the Backstage web interface.
      * @visibility frontend
      */
     title?: string;
@@ -43,7 +43,7 @@ export interface Config {
       /**
        * A list of categorized support item groupings.
        */
-      items: {
+      items: Array<{
         /**
          * The title of the support item grouping.
          * @visibility frontend
@@ -55,15 +55,15 @@ export interface Config {
          */
         icon?: string;
         /**
-         * A list of support links for the Backstage instance.
+         * A list of support links for the Backstage instance inside this grouping.
          */
-        links: {
+        links: Array<{
           /** @visibility frontend */
           url: string;
           /** @visibility frontend */
           title?: string;
-        }[];
-      }[];
+        }>;
+      }>;
     };
   };
 
@@ -72,7 +72,7 @@ export interface Config {
    */
   backend: {
     /**
-     * The public absolute root URL that the backend is reachable at.
+     * The public absolute root URL that the backend is reachable at, from the browser's perspective.
      * @visibility frontend
      */
     baseUrl: string;
@@ -90,16 +90,16 @@ export interface Config {
   };
 
   homepage?: {
-    clocks?: {
+    clocks?: Array<{
       /** @visibility frontend */
       label: string;
       /** @visibility frontend */
       timezone: string;
-    }[];
+    }>;
   };
 
   /**
-   * Configuration that provides information on available authentication providers configured for app
+   * Configuration that provides information on available configured authentication providers.
    */
   auth?: {
     /**

plugins/kafka-backend/config.d.ts

@@ -19,7 +19,7 @@ export interface Config {
      * Client ID used to Backstage uses to identify when connecting to the Kafka cluster.
      */
     clientId: string;
-    clusters: {
+    clusters: Array<{
       name: string;
       /**
        * List of brokers in the Kafka cluster to connect to.
@@ -46,6 +46,6 @@ export interface Config {
         /** @visibility secret */
         password: string;
       };
-    }[];
+    }>;
   };
 }