$defs => definitions for draft 7

bkeepers · bkeepers · commit 270f290df0bb · 2023-04-03T08:09:38.000-04:00
diff --git a/packages/expressions/README.md b/packages/expressions/README.md
@@ -9,7 +9,7 @@ To learn more about JSON Schema, read [Understanding JSON Schema](https://json-s
 ## Adding a new expression
 
 1. Describe arguments by creating a new file in [`schemas/`](schemas/) named `NewName.schema.json`. You can copy an existing function that has similar semantics to get started.
-2. Add the new function in [`schemas/schema.json`](schemas/schema.json) to `$defs/function`.
+2. Add the new function in [`schemas/schema.json`](schemas/schema.json) to `definitions/function`.
 3. Create a new file in [`examples/`](./examples) named `NewName.json` with valid and invalid examples for the new function. See other examples for inspiration.
 4. Run `yarn test` in `packages/expressions` and ensure tests pass.
 5. Implement the function in [`lib/flipper/expressions/`](../../lib/flipper/expressions/).
diff --git a/packages/expressions/schemas/All.schema.json b/packages/expressions/schemas/All.schema.json
@@ -3,5 +3,5 @@
   "$id": "https://www.flippercloud.io/expressions/All.schema.json",
   "title": "All",
   "description": "Returns true if all of the expressions return true.",
-  "$ref": "schema.json#/$defs/arguments-n"
+  "$ref": "schema.json#/definitions/arguments-n"
 }
diff --git a/packages/expressions/schemas/Any.schema.json b/packages/expressions/schemas/Any.schema.json
@@ -3,5 +3,5 @@
   "$id": "https://www.flippercloud.io/expressions/Any.schema.json",
   "title": "Any",
   "description": "Returns true if any of the expressions return true.",
-  "$ref": "schema.json#/$defs/arguments-n"
+  "$ref": "schema.json#/definitions/arguments-n"
 }
diff --git a/packages/expressions/schemas/Boolean.schema.json b/packages/expressions/schemas/Boolean.schema.json
@@ -3,5 +3,5 @@
   "$id": "https://www.flippercloud.io/expressions/Boolean.schema.json",
   "title": "Boolean",
   "description": "Cast a value to a boolean.",
-  "$ref": "schema.json#/$defs/argument"
+  "$ref": "schema.json#/definitions/argument"
 }
diff --git a/packages/expressions/schemas/Duration.schema.json b/packages/expressions/schemas/Duration.schema.json
@@ -5,17 +5,17 @@
   "description": "A period of time expressed as a number of seconds, minutes, hours, days, weeks, months, or years.",
   "type": "array",
   "items": [
-    { "$ref": "schema.json#/$defs/number" },
+    { "$ref": "schema.json#/definitions/number" },
     {
       "anyOf": [
-        { "$ref": "#/$defs/unit" },
-        { "$ref": "schema.json#/$defs/function" }
+        { "$ref": "#/definitions/unit" },
+        { "$ref": "schema.json#/definitions/function" }
       ]
     }
   ],
   "minItems": 2,
   "maxItems": 2,
-  "$defs": {
+  "definitions": {
     "unit": {
       "type": "string",
       "enum": ["seconds", "minutes", "hours", "days", "weeks", "months", "years"],
diff --git a/packages/expressions/schemas/Equal.schema.json b/packages/expressions/schemas/Equal.schema.json
@@ -3,5 +3,5 @@
   "$id": "https://www.flippercloud.io/expressions/Equal.schema.json",
   "title": "Equal",
   "description": "Compare two values for equality",
-  "$ref": "schema.json#/$defs/arguments-two"
+  "$ref": "schema.json#/definitions/arguments-two"
 }
diff --git a/packages/expressions/schemas/GreaterThan.schema.json b/packages/expressions/schemas/GreaterThan.schema.json
@@ -3,5 +3,5 @@
   "$id": "https://www.flippercloud.io/expressions/GreaterThan.schema.json",
   "title": "GreaterThan",
   "description": "Compare if the first argument is > the second argument.",
-  "$ref": "schema.json#/$defs/arguments-two"
+  "$ref": "schema.json#/definitions/arguments-two"
 }
diff --git a/packages/expressions/schemas/GreaterThanOrEqualTo.schema.json b/packages/expressions/schemas/GreaterThanOrEqualTo.schema.json
@@ -3,5 +3,5 @@
   "$id": "https://www.flippercloud.io/expressions/GreaterThanOrEqualTo.schema.json",
   "title": "GreaterThanOrEqualTo",
   "description": "Compare if the first argument is >= the second argument.",
-  "$ref": "schema.json#/$defs/arguments-two"
+  "$ref": "schema.json#/definitions/arguments-two"
 }
diff --git a/packages/expressions/schemas/LessThan.schema.json b/packages/expressions/schemas/LessThan.schema.json
@@ -3,5 +3,5 @@
   "$id": "https://www.flippercloud.io/expressions/LessThan.schema.json",
   "title": "LessThan",
   "description": "Compare if the first argument is < the second argument.",
-  "$ref": "schema.json#/$defs/arguments-two"
+  "$ref": "schema.json#/definitions/arguments-two"
 }
diff --git a/packages/expressions/schemas/LessThanOrEqualTo.schema.json b/packages/expressions/schemas/LessThanOrEqualTo.schema.json
@@ -3,5 +3,5 @@
   "$id": "https://www.flippercloud.io/expressions/LessThanOrEqualTo.schema.json",
   "title": "LessThanOrEqualTo",
   "description": "Compare if the first argument is < the second argument.",
-  "$ref": "schema.json#/$defs/arguments-two"
+  "$ref": "schema.json#/definitions/arguments-two"
 }
diff --git a/packages/expressions/schemas/Max.schema.json b/packages/expressions/schemas/Max.schema.json
@@ -3,5 +3,5 @@
   "$id": "https://www.flippercloud.io/expressions/Max.schema.json",
   "title": "Max",
   "description": "Returns the maximum value in a list.",
-  "$ref": "schema.json#/$defs/arguments-n"
+  "$ref": "schema.json#/definitions/arguments-n"
 }
diff --git a/packages/expressions/schemas/Min.schema.json b/packages/expressions/schemas/Min.schema.json
@@ -3,5 +3,5 @@
   "$id": "https://www.flippercloud.io/expressions/Min.schema.json",
   "title": "Min",
   "description": "Returns the minimum value in a list.",
-  "$ref": "schema.json#/$defs/arguments-n"
+  "$ref": "schema.json#/definitions/arguments-n"
 }
diff --git a/packages/expressions/schemas/NotEqual.schema.json b/packages/expressions/schemas/NotEqual.schema.json
@@ -3,5 +3,5 @@
   "$id": "https://www.flippercloud.io/expressions/NotEqual.schema.json",
   "title": "NotEqual",
   "description": "Compare two values for equality",
-  "$ref": "schema.json#/$defs/arguments-two"
+  "$ref": "schema.json#/definitions/arguments-two"
 }
diff --git a/packages/expressions/schemas/Number.schema.json b/packages/expressions/schemas/Number.schema.json
@@ -3,5 +3,5 @@
   "$id": "https://www.flippercloud.io/expressions/Number.schema.json",
   "title": "Number",
   "description": "Cast a value to a number.",
-  "$ref": "schema.json#/$defs/argument"
+  "$ref": "schema.json#/definitions/argument"
 }
diff --git a/packages/expressions/schemas/Percentage.schema.json b/packages/expressions/schemas/Percentage.schema.json
@@ -4,7 +4,7 @@
   "title": "Percentage",
   "description": "Cast a value to a percentage between 0 and 100.",
   "type": "array",
-  "items": { "$ref": "schema.json#/$defs/number" },
+  "items": { "$ref": "schema.json#/definitions/number" },
   "minItems": 1,
   "maxItems": 1
 }
diff --git a/packages/expressions/schemas/PercentageOfActors.schema.json b/packages/expressions/schemas/PercentageOfActors.schema.json
@@ -5,8 +5,8 @@
   "description": "",
   "type": "array",
   "items": [
-    { "$ref": "schema.json#/$defs/string" },
-    { "$ref": "schema.json#/$defs/number" }
+    { "$ref": "schema.json#/definitions/string" },
+    { "$ref": "schema.json#/definitions/number" }
   ],
   "minItems": 2,
   "maxItems": 2
diff --git a/packages/expressions/schemas/Property.schema.json b/packages/expressions/schemas/Property.schema.json
@@ -4,7 +4,7 @@
   "title": "Property",
   "description": "Extract a property from context[properties].",
   "type": "array",
-  "items": { "$ref": "schema.json#/$defs/string" },
+  "items": { "$ref": "schema.json#/definitions/string" },
   "minItems": 1,
   "maxItems": 1
 }
diff --git a/packages/expressions/schemas/Random.schema.json b/packages/expressions/schemas/Random.schema.json
@@ -4,6 +4,6 @@
   "title": "Random",
   "description": "Return a random number",
   "type": "array",
-  "items": { "$ref": "schema.json#/$defs/number" },
+  "items": { "$ref": "schema.json#/definitions/number" },
   "maxItems": 1
 }
diff --git a/packages/expressions/schemas/String.schema.json b/packages/expressions/schemas/String.schema.json
@@ -3,5 +3,5 @@
   "$id": "https://www.flippercloud.io/expressions/String.schema.json",
   "title": "String",
   "description": "Cast a value to a string.",
-  "$ref": "schema.json#/$defs/argument"
+  "$ref": "schema.json#/definitions/argument"
 }
diff --git a/packages/expressions/schemas/Time.schema.json b/packages/expressions/schemas/Time.schema.json
@@ -4,14 +4,14 @@
   "title": "Time",
   "description": "A time in ISO8601 format",
   "type": "array",
+  "items": { "$ref": "#/definitions/argument" },
   "minItems": 1,
   "maxItems": 1,
-  "items": { "$ref": "#/$defs/argument" },
-  "$defs": {
+  "definitions": {
     "argument": {
       "anyOf": [
         { "type": "string", "format": "date-time" },
-        { "$ref": "schema.json#/$defs/function" }
+        { "$ref": "schema.json#/definitions/function" }
       ]
     }
   }
diff --git a/packages/expressions/schemas/schema.json b/packages/expressions/schemas/schema.json
@@ -3,19 +3,27 @@
   "$id": "https://www.flippercloud.io/expressions/schema.json",
   "title": "Flipper Expressions",
   "description": "TODO",
-  "$ref": "#/$defs/expression",
-  "$defs": {
+  "$ref": "#/definitions/expression",
+  "definitions": {
     "expression": {
       "title": "Expression",
-      "description": "An expression can be a function or a constant (string, boolean, or number)",
+      "description": "An expression can be a Function or a Constant",
+      "anyOf": [
+        { "$ref": "#/definitions/constant" },
+        { "$ref": "#/definitions/function" }
+      ]
+    },
+    "constant": {
+      "title": "Constant",
+      "description": "A constant value can be a string, number or boolean",
       "anyOf": [
-        { "$ref": "#/$defs/function" },
         { "type": "string" },
         { "type": "number" },
         { "type": "boolean" }
       ]
     },
     "function": {
+      "title": "Function",
       "description": "A function is an object with a single property that is the name of the function and the value is the arguments to the function",
       "type": "object",
       "maxProperties": 1,
@@ -48,32 +56,33 @@
       "description": "A constant string value or a function that returns a string",
       "anyOf": [
         { "type": "string" },
-        { "$ref": "#/$defs/function" }
+        { "$ref": "#/definitions/function" }
       ]
     },
     "number": {
       "description": "A constant numeric value or a function that returns a number",
       "anyOf": [
         { "type": "number" },
-        { "$ref": "#/$defs/function" }
+        { "$ref": "#/definitions/function" }
       ]
     },
     "arguments-n": {
-      "description": "A single expression or an array of expressions",
+      "description": "An array of expressions",
       "type": "array",
-      "items": { "$ref": "#/$defs/expression" }
+      "items": { "$ref": "#/definitions/expression" },
+      "minItems": 0
     },
     "arguments-two": {
       "description": "An array with exactly two expressions",
       "type": "array",
-      "items": { "$ref": "#/$defs/expression" },
+      "items": { "$ref": "#/definitions/expression" },
       "minItems": 2,
       "maxItems": 2
     },
     "argument": {
-      "description": "A single expression or an array with at most one expression",
+      "description": "An array with exactly one expression",
       "type": "array",
-      "items": { "$ref": "#/$defs/expression" },
+      "items": { "$ref": "#/definitions/expression" },
       "minItems": 1,
       "maxItems": 1
     }
diff --git a/packages/expressions/test/schemas.test.js b/packages/expressions/test/schemas.test.js
@@ -1,6 +1,5 @@
 import { describe, test, expect } from 'vitest'
-import { validate } from '../lib'
-import examples from '../examples'
+import { validate, examples } from '../lib'
 
 expect.extend({
   toBeValid (received) {

Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@`
`3`	`3`	`"$id": "https://www.flippercloud.io/expressions/All.schema.json",`
`4`	`4`	`"title": "All",`
`5`	`5`	`"description": "Returns true if all of the expressions return true.",`
`6`		`- "$ref": "schema.json#/$defs/arguments-n"`
	`6`	`+ "$ref": "schema.json#/definitions/arguments-n"`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@`
`3`	`3`	`"$id": "https://www.flippercloud.io/expressions/Any.schema.json",`
`4`	`4`	`"title": "Any",`
`5`	`5`	`"description": "Returns true if any of the expressions return true.",`
`6`		`- "$ref": "schema.json#/$defs/arguments-n"`
	`6`	`+ "$ref": "schema.json#/definitions/arguments-n"`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@`
`3`	`3`	`"$id": "https://www.flippercloud.io/expressions/Boolean.schema.json",`
`4`	`4`	`"title": "Boolean",`
`5`	`5`	`"description": "Cast a value to a boolean.",`
`6`		`- "$ref": "schema.json#/$defs/argument"`
	`6`	`+ "$ref": "schema.json#/definitions/argument"`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@`
`3`	`3`	`"$id": "https://www.flippercloud.io/expressions/Equal.schema.json",`
`4`	`4`	`"title": "Equal",`
`5`	`5`	`"description": "Compare two values for equality",`
`6`		`- "$ref": "schema.json#/$defs/arguments-two"`
	`6`	`+ "$ref": "schema.json#/definitions/arguments-two"`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@`
`3`	`3`	`"$id": "https://www.flippercloud.io/expressions/GreaterThan.schema.json",`
`4`	`4`	`"title": "GreaterThan",`
`5`	`5`	`"description": "Compare if the first argument is > the second argument.",`
`6`		`- "$ref": "schema.json#/$defs/arguments-two"`
	`6`	`+ "$ref": "schema.json#/definitions/arguments-two"`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@`
`3`	`3`	`"$id": "https://www.flippercloud.io/expressions/GreaterThanOrEqualTo.schema.json",`
`4`	`4`	`"title": "GreaterThanOrEqualTo",`
`5`	`5`	`"description": "Compare if the first argument is >= the second argument.",`
`6`		`- "$ref": "schema.json#/$defs/arguments-two"`
	`6`	`+ "$ref": "schema.json#/definitions/arguments-two"`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@`
`3`	`3`	`"$id": "https://www.flippercloud.io/expressions/LessThan.schema.json",`
`4`	`4`	`"title": "LessThan",`
`5`	`5`	`"description": "Compare if the first argument is < the second argument.",`
`6`		`- "$ref": "schema.json#/$defs/arguments-two"`
	`6`	`+ "$ref": "schema.json#/definitions/arguments-two"`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@`
`3`	`3`	`"$id": "https://www.flippercloud.io/expressions/LessThanOrEqualTo.schema.json",`
`4`	`4`	`"title": "LessThanOrEqualTo",`
`5`	`5`	`"description": "Compare if the first argument is < the second argument.",`
`6`		`- "$ref": "schema.json#/$defs/arguments-two"`
	`6`	`+ "$ref": "schema.json#/definitions/arguments-two"`
`7`	`7`	`}`