docs and scheme

Signed-off-by: razzle <[email protected]>
zarf-dev · Jan 2, 2024 · c93fabd · c93fabd
1 parent b27ed3b
commit c93fabd
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/docs/3-create-a-zarf-package/4-zarf-schema.md b/docs/3-create-a-zarf-package/4-zarf-schema.md
@@ -611,12 +611,12 @@ must respect the following conditions
 
 <details>
 <summary>
-<strong> <a name="components_items_required"></a>required</strong>
+<strong> <a name="components_items_optional"></a>optional</strong>
 </summary>
 &nbsp;
 <blockquote>
 
-**Description:** Do not prompt user to install this component
+**Description:** Prompt user to install this component on package deploy
 
 |          |           |
 | -------- | --------- |

diff --git a/zarf.schema.json b/zarf.schema.json
@@ -225,7 +225,11 @@
         },
         "required": {
           "type": "boolean",
-          "description": "Do not prompt user to install this component"
+          "description": "[Deprecated] Do not prompt user to install this component"
+        },
+        "optional": {
+          "type": "boolean",
+          "description": "Prompt user to install this component on package deploy"
         },
         "only": {
           "$schema": "http://json-schema.org/draft-04/schema#",