updates on the comments section

2020-12-17 13:33:28 +05:30
parent 8e12093fe8
commit 25bbdccba6
1 changed files with 9 additions and 4 deletions
@@ -21,13 +21,18 @@ export interface Config {
  catalog?: {
    /**
     * Rules to apply to catalog entities - accepts an array of objects with below attributes
-     *  attr: 'allow' - accepts an array of string. e.g. [Component, API, Group, User, Template, Location]
-     *  opt-attr: 'locations' - accepts an array of key, value pair objects.
-     *    keys: 'target', 'type'
-     *    e.g.[{type: url, target: https://github.com}]
     */
    rules?: Array<{
+      /**
+       * attr: 'allow' - accepts an array of string. e.g. [Component, API, Group, User, Template, Location]
+       */
      allow: Array<string>;
+      /**
+       * opt-attr: 'locations' - accepts an array of key, value pair objects.
+       * keys: 'target', 'type'
+       * e.g.[{type: url, target: https://github.com}]
+       *
+       */
      locations?: Array<{ [key: string]: string }>;
    }>;
    /**