address config schema review comments

packages/backend-common/config.d.ts

@@ -21,8 +21,8 @@ export interface Config {
 
   backend: {
     baseUrl: string; // defined in core, but repeated here without doc
-    /** Address that the backend should listen to. */
 
+    /** Address that the backend should listen to. */
     listen:
       | string
       | {
@@ -86,7 +86,7 @@ export interface Config {
   /** Configuration for integrations towards various external repository provider systems */
   integrations?: {
     /** Integration configuration for Azure */
-    azure?: {
+    azure?: Array<{
       /** The hostname of the given Azure instance */
       host: string;
       /**
@@ -94,10 +94,10 @@ export interface Config {
        * @visibility secret
        */
       token?: string;
-    }[];
+    }>;
 
     /** Integration configuration for BitBucket */
-    bitbucket?: {
+    bitbucket?: Array<{
       /** The hostname of the given Bitbucket instance */
       host: string;
       /**
@@ -117,10 +117,10 @@ export interface Config {
        * @visibility secret
        */
       appPassword?: string;
-    }[];
+    }>;
 
     /** Integration configuration for GitHub */
-    github?: {
+    github?: Array<{
       /** The hostname of the given GitHub instance */
       host: string;
       /**
@@ -132,10 +132,10 @@ export interface Config {
       apiBaseUrl?: string;
       /** The base url for GitHub raw resources, for example https://raw.githubusercontent.com */
       rawBaseUrl?: string;
-    }[];
+    }>;
 
     /** Integration configuration for GitLab */
-    gitlab?: {
+    gitlab?: Array<{
       /** The hostname of the given GitLab instance */
       host: string;
       /**
@@ -143,6 +143,6 @@ export interface Config {
        * @visibility secret
        */
       token?: string;
-    }[];
+    }>;
   };
 }

packages/config-loader/src/lib/schema/types.ts

@@ -21,11 +21,11 @@ import { AppConfig, JsonObject } from '@backstage/config';
  */
 export type ConfigSchemaPackageEntry = {
   /**
-   * The configuration schema itself, as JSONSchema draft-07
+   * The configuration schema itself.
    */
   value: JsonObject;
   /**
-   * The path that the configuration schema was discovered at.
+   * The relative path that the configuration schema was discovered at.
    */
   path: string;
 };
@@ -59,7 +59,7 @@ type ValidationResult = {
    */
   errors?: ValidationError[];
   /**
-   * The configuration visibilities the where discovered during validation.
+   * The configuration visibilities that were discovered during validation.
    *
    * The path in the key uses the form `/<key>/<sub-key>/<array-index>/<leaf-key>`
    */