fix(config): add descriptions to JSON schema properties

ubq-testing · Nov 26, 2024 · f3bc570 · f3bc570
1 parent 5dcb30c
commit f3bc570
Showing 1 changed file with 9 additions and 9 deletions.
diff --git a/src/types/plugin-input.ts b/src/types/plugin-input.ts
@@ -4,33 +4,33 @@ export const pluginSettingsSchema = T.Object(
   {
     globalConfigUpdate: T.Optional(
       T.Object({
-        excludeRepos: T.Array(T.String()),
-      })
+        excludeRepos: T.Array(T.String(), { description: "List of repositories to exclude from being updated" }),
+      }, { description: "Updates all price labels across all tasks based on `baseRateMultiplier` changes within the config file." }),
     ),
     labels: T.Object(
       {
         time: T.Array(
           T.Object({
-            name: T.String({ description: "The display name of the label" }),
-            collaboratorOnly: T.Boolean({ default: false, description: "Whether the label is only available to collaborators" }),
+            name: T.String({ description: "The display name of the label representing estimated task length" }),
+            collaboratorOnly: T.Boolean({ default: false, description: "Whether the task is only available for collaborators to be assigned" }),
           }),
           { default: [] }
         ),
         priority: T.Array(
           T.Object({
-            name: T.String(),
-            collaboratorOnly: T.Boolean({ default: false }),
+            name: T.String({ description: "The display name of the label representing task priority" }),
+            collaboratorOnly: T.Boolean({ default: false, description: "Whether the task is only available for collaborators to be assigned" }),
           }),
           { default: [] }
         ),
       },
       { default: {} }
     ),
-    basePriceMultiplier: T.Number({ default: 1 }),
+    basePriceMultiplier: T.Number({ default: 1, description: "The base price multiplier for all tasks" }),
     publicAccessControl: T.Object(
       {
-        setLabel: T.Boolean({ default: false }),
-        fundExternalClosedIssue: T.Boolean({ default: false }),
+        setLabel: T.Boolean({ default: false, description: "Whether to allow anyone to set labels, false to perform permission validation" }),
+        fundExternalClosedIssue: T.Boolean({ default: false, description: "Whether to allow funding external closed issues" }),
       },
       { default: {} }
     ),