Add Config API interface jsdoc

2020-12-10 16:03:41 -05:00
parent 26518c1d68
commit 5010207814
1 changed files with 4 additions and 1 deletions
@@ -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<ConfigApi> = createApiRef({