From 31d35d89f6176b28f68ef468f5e842e27c4ddd86 Mon Sep 17 00:00:00 2001 From: bracesproul Date: Tue, 23 Apr 2024 16:25:37 -0700 Subject: [PATCH] more jsdoc --- js/src/schemas.ts | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/js/src/schemas.ts b/js/src/schemas.ts index 334c18d8f..b28d86e86 100644 --- a/js/src/schemas.ts +++ b/js/src/schemas.ts @@ -315,6 +315,9 @@ export interface FeedbackCategory { export interface FeedbackConfig { /** * The type of feedback. + * - "continuous": Feedback with a continuous numeric. + * - "categorical": Feedback with a categorical value (classes) + * - "freeform": Feedback with a freeform text value (notes). */ type: "continuous" | "categorical" | "freeform"; @@ -329,6 +332,9 @@ export interface FeedbackConfig { max?: number | null; /** + * The categories for categorical feedback. + * Each category can be a string or an object with additional properties. + * * If feedback is categorical, this defines the valid categories the server will accept. * Not applicable to continuous or freeform feedback types. */