From 501020781426ea8db2b1c92ead3c962d6f425083 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Thu, 10 Dec 2020 16:03:41 -0500 Subject: [PATCH] Add Config API interface jsdoc --- packages/core-api/src/apis/definitions/ConfigApi.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/packages/core-api/src/apis/definitions/ConfigApi.ts b/packages/core-api/src/apis/definitions/ConfigApi.ts index 2ce972af0e..459a361cf7 100644 --- a/packages/core-api/src/apis/definitions/ConfigApi.ts +++ b/packages/core-api/src/apis/definitions/ConfigApi.ts @@ -16,7 +16,10 @@ import { ApiRef, createApiRef } from '../system'; import { Config } from '@backstage/config'; -// Using interface to make the ConfigApi name show up in docs +/** + * The Config API is used to provide a mechanism to access the + * runtime configuration of the system. + */ export type ConfigApi = Config; export const configApiRef: ApiRef = createApiRef({