feat(parameter-schema): add new keyword optional for the parameter sc…

…hema (#111)
aica-technology · Jan 18, 2024 · 66618f0 · 66618f0
1 parent a0cb3dd
commit 66618f0
Show file tree

Hide file tree

Showing 7 changed files with 106 additions and 15 deletions.
diff --git a/schemas/applications/CHANGELOG.md b/schemas/applications/CHANGELOG.md
@@ -2,9 +2,14 @@
 
 Release Versions:
 
+- [1-1-0](#110)
 - [1-0-0](#100)
 
-## Upcoming changes
+## 1-1-0
+
+Version 1-1-0 fixes an error in the application schema related to required field in the hardware schema.
+
+### Changelog
 
 - fix: required fields for hardware schema (#97)
 

diff --git a/schemas/component-descriptions/CHANGELOG.md b/schemas/component-descriptions/CHANGELOG.md
@@ -0,0 +1,20 @@
+# CHANGELOG
+
+Release Versions:
+
+- [1-1-0](#110)
+- [1-0-0](#100)
+
+## 1-1-0
+
+Version 1-1-0 adds a new property `optional` to the parameter schema to indicate if the user needs to specify a value in
+case a parameter doesn't have a default value.
+
+### Changelog
+
+- feat(parameter-schema): add new keyword optional for the parameter schema (#111)
+
+## 1-0-0
+
+Version 1-0-0 marks the version for the first software release. From now on, all changes must be well documented and
+semantic versioning must be maintained to reflect patch, minor or major changes.
diff --git a/schemas/component-descriptions/README.md b/schemas/component-descriptions/README.md
@@ -265,7 +265,7 @@ the JSON file.
 
 ```json
 {
-  "$schema": "https://docs.aica.tech/schemas/1-0-0/component.schema.json"
+  "$schema": "https://docs.aica.tech/schemas/1-1-0/component.schema.json"
 }
 ```
 
@@ -281,7 +281,7 @@ For step 3, give the Schema a useful name (such as "Component Description") and
 In the "Schema file or URL field", enter the following URL:
 
 ```
-https://docs.aica.tech/schemas/1-0-0/component.schema.json
+https://docs.aica.tech/schemas/1-1-0/component.schema.json
 ```
 
 For step 4, either manually specify files and directories to be validated, or use the file path pattern

diff --git a/schemas/component-descriptions/schema/component.schema.json b/schemas/component-descriptions/schema/component.schema.json
@@ -1,10 +1,19 @@
 {
-  "$id": "/1-0-0/component.schema.json",
+  "$id": "/1-1-0/component.schema.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "title": "Dynamic Component Description",
   "description": "A full description of a dynamic component in the AICA application framework.",
   "type": "object",
+  "additionalProperties": false,
   "properties": {
+    "$schema": {
+      "title": "Schema",
+      "description": "The reference to the schema",
+      "examples": [
+        "https://json-schema.org/draft/2020-12/schema"
+      ],
+      "type": "string"
+    },
     "name": {
       "title": "Component Name",
       "description": "The human-readable name of the component.",

diff --git a/schemas/controller-descriptions/CHANGELOG.md b/schemas/controller-descriptions/CHANGELOG.md
@@ -0,0 +1,20 @@
+# CHANGELOG
+
+Release Versions:
+
+- [1-1-0](#110)
+- [1-0-0](#100)
+
+## 1-1-0
+
+Version 1-1-0 adds a new property `optional` to the parameter schema to indicate if the user needs to specify a value in
+case a parameter doesn't have a default value.
+
+### Changelog
+
+- feat(parameter-schema): add new keyword optional for the parameter schema (#111)
+
+## 1-0-0
+
+Version 1-0-0 marks the version for the first software release. From now on, all changes must be well documented and
+semantic versioning must be maintained to reflect patch, minor or major changes.
diff --git a/schemas/controller-descriptions/schema/controller.schema.json b/schemas/controller-descriptions/schema/controller.schema.json
@@ -1,10 +1,19 @@
 {
-  "$id": "/1-0-0/controller.schema.json",
+  "$id": "/1-1-0/controller.schema.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "title": "AICA Controller Description",
   "description": "A full description of a controller in the AICA application framework.",
   "type": "object",
+  "additionalProperties": false,
   "properties": {
+    "$schema": {
+      "title": "Schema",
+      "description": "The reference to the schema",
+      "examples": [
+        "https://json-schema.org/draft/2020-12/schema"
+      ],
+      "type": "string"
+    },
     "name": {
       "title": "Controller Name",
       "description": "The human-readable name of the controller.",

diff --git a/schemas/parameters/schema/parameter.schema.json b/schemas/parameters/schema/parameter.schema.json
@@ -3,6 +3,7 @@
   "title": "Parameter",
   "description": "A dynamic parameter that is publicly configurable.",
   "type": "object",
+  "additionalProperties": false,
   "properties": {
     "display_name": {
       "description": "The human-readable parameter name.",
@@ -48,6 +49,10 @@
         }
       ]
     },
+    "optional": {
+      "description": "Specify if this parameter is optional (only applicable if the default value is null)",
+      "type": "boolean"
+    },
     "dynamic": {
       "description": "Specify if this parameter can be dynamically reconfigured.",
       "type": "boolean"
@@ -65,16 +70,39 @@
     "parameter_type",
     "default_value"
   ],
-  "if": {
-    "properties": {
-      "parameter_type": {
-        "const": "state"
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "default_value": {
+            "not": {
+              "const": null
+            }
+          }
+        }
+      },
+      "then": {
+        "not": {
+          "required": [
+            "optional"
+          ]
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "parameter_type": {
+            "const": "state"
+          }
+        }
+      },
+      "then": {
+        "required": [
+          "parameter_state_type"
+        ]
       }
     }
-  },
-  "then": {
-    "required": [
-      "parameter_state_type"
-    ]
-  }
+
+  ]
 }