add example for required fields

kendraio · Jan 20, 2025 · 7f5671b · 7f5671b
1 parent c50db24
commit 7f5671b
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/docs/workflow/blocks/form.rst b/docs/workflow/blocks/form.rst
@@ -336,6 +336,9 @@ An example of the array type in action is `here <https://app.kendra.io/bandsinto
                         },
                         "name": {
                             "type": "string"
+                        },
+                        "active": {
+                            "type": "boolean"
                         }
                     }
                 }
@@ -369,6 +372,32 @@ Display a field in read-only mode (not editable)
     "uiSchema": {}
   }
 
+Required fields
+^^^^^^^^^^^^^^^
+Make a field required
+
+.. code-block:: json
+
+  {
+    "type": "form",
+    "label": "Search",
+    "jsonSchema": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "title": "Name"
+          },
+          "age": {
+            "type": "string",
+            "title": "Age"
+          }
+        },
+        "required": ["name"]  // 'name' is required, 'age' is optional
+    },
+    "uiSchema": {}
+  }
+
 
 No submit button
 ^^^^^^^^^^^^^^^^