improve schema for Time object to generate better TS types

NASA-AMMOS · Feb 10, 2025 · aa40c33 · aa40c33
1 parent a86786f
commit aa40c33
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 23 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@nasa-jpl/seq-json-schema",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "license": "MIT",
   "type": "module",
   "repository": {

diff --git a/schema.json b/schema.json
@@ -477,30 +477,32 @@
     "time": {
       "additionalProperties": false,
       "description": "Time object",
-      "properties": {
-        "tag": {
-          "description": "Relative or absolute time. Required for ABSOLUTE, BLOCK_RELATIVE, COMMAND_RELATIVE, and EPOCH_RELATIVE time types but not COMMAND_COMPLETE.",
-          "type": "string"
+      "oneOf": [
+        {
+          "additionalProperties": false,
+          "properties": {
+            "type": {
+              "description": "Allowed time types without a tag: COMMAND_COMPLETE",
+              "enum": ["COMMAND_COMPLETE"],
+              "type": "string"
+            }
+          },
+          "required": ["type"]
         },
-        "type": {
-          "description": "Allowed time types: ABSOLUTE, BLOCK_RELATIVE, COMMAND_RELATIVE, EPOCH_RELATIVE, or COMMAND_COMPLETE.",
-          "enum": ["ABSOLUTE", "BLOCK_RELATIVE", "COMMAND_RELATIVE", "EPOCH_RELATIVE", "COMMAND_COMPLETE"],
-          "type": "string"
-        }
-      },
-      "required": ["type"],
-      "allOf": [
         {
-          "if": {
-            "properties": {
-              "type": {
-                "enum": ["ABSOLUTE", "BLOCK_RELATIVE", "COMMAND_RELATIVE", "EPOCH_RELATIVE"]
-              }
+          "additionalProperties": false,
+          "properties": {
+            "type": {
+              "description": "Allowed time types with a tag: ABSOLUTE, BLOCK_RELATIVE, COMMAND_RELATIVE, EPOCH_RELATIVE.",
+              "enum": ["ABSOLUTE", "BLOCK_RELATIVE", "COMMAND_RELATIVE", "EPOCH_RELATIVE"],
+              "type": "string"
+            },
+            "tag": {
+              "description": "Relative or absolute time. Required for ABSOLUTE, BLOCK_RELATIVE, COMMAND_RELATIVE, and EPOCH_RELATIVE time types but not COMMAND_COMPLETE.",
+              "type": "string"
             }
           },
-          "then": {
-            "required": ["tag"]
-          }
+          "required": ["type", "tag"]
         }
       ],
       "type": "object"