Merge pull request #6074 from lunarway/docs/config-visibility

Add example of visibility of config values
2021-06-17 09:33:08 +02:00
parent 6c7308509c 23ad991a17
commit 4aac63d17c
1 changed files with 15 additions and 0 deletions
@@ -93,6 +93,21 @@ declare the visibility of a leaf node of `type: "string"`.
 | `backend`    | (Default) Only in backend                                          |
 | `secret`     | Only in backend and may be excluded from logs for security reasons |

+You can set visibility with an `@visibility` comment in the `Config` Typescript
+interface.
+
+```ts
+export interface Config {
+  app: {
+    /**
+     * Frontend root URL
+     * @visibility frontend
+     */
+    baseUrl: string;
+  };
+}
+```
+
 ## Validation

 Schemas can be validated using the `backstage-cli config:check` command. If you