fixup: validate top-level object in targeting.json

Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
open-feature · Jul 5, 2024 · 41e3d71 · 41e3d71
1 parent 2b9fb80
commit 41e3d71
Show file tree

Hide file tree

Showing 24 changed files with 487 additions and 471 deletions.
diff --git a/json/flags.json b/json/flags.json
@@ -2,7 +2,7 @@
   "$id": "https://flagd.dev/schema/v0/flags.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "flagd Flag Configuration",
-  "description": "Defines flags for use in flagd, including typed variants and rules",
+  "description": "Defines flags for use in flagd, including typed variants and rules.",
   "type": "object",
   "properties": {
     "flags": {
@@ -46,7 +46,7 @@
       "patternProperties": {
         "^.{1,}$": {
           "$comment": "this relative ref means that targeting.json MUST be in the same dir, or available on the same HTTP path",
-          "$ref": "./targeting.json#/definitions/targeting"
+          "$ref": "./targeting.json"
         }
       }
     }
@@ -71,7 +71,7 @@
           "type": "string"
         },
         "targeting": {
-          "$ref": "./targeting.json#/definitions/targeting"
+          "$ref": "./targeting.json"
         }
       },
       "required": [

diff --git a/json/flags.yaml b/json/flags.yaml
@@ -1,7 +1,7 @@
 $id: "https://flagd.dev/schema/v0/flags.json"
 $schema: http://json-schema.org/draft-07/schema#
 title: flagd Flag Configuration
-description: Defines flags for use in flagd, including typed variants and rules
+description: Defines flags for use in flagd, including typed variants and rules.
 type: object
 properties:
   flags:
@@ -35,7 +35,7 @@ properties:
       "^.{1,}$":
         $comment: this relative ref means that targeting.json MUST be in the same
           dir, or available on the same HTTP path
-        $ref: "./targeting.json#/definitions/targeting"
+        $ref: "./targeting.json"
 definitions:
   flag:
     $comment: base flag object; no title/description here, allows for better UX,
@@ -56,7 +56,7 @@ definitions:
           if the targeting returns null).
         type: string
       targeting:
-        $ref: "./targeting.json#/definitions/targeting"
+        $ref: "./targeting.json"
     required:
     - state
     - defaultVariant

diff --git a/json/targeting.json b/json/targeting.json
@@ -2,29 +2,20 @@
   "$id": "https://flagd.dev/schema/v0/targeting.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "flagd Targeting",
-  "description": "Defines targeting logic for flagd; a extension of JSONLogic, including purpose-built feature-flagging operations.",
+  "description": "Defines targeting logic for flagd; a extension of JSONLogic, including purpose-built feature-flagging operations. Note that this schema applies to top-level objects; no additional properties are supported, including \"$schema\", which means built-in JSON-schema support is not possible in editors. Please use flags.json (which imports this schema) for a rich editor experience.",
   "type": "object",
-  "properties": {
-    "targeting": {
-      "$ref": "#/definitions/targeting"
+  "anyOf": [
+    {
+      "$comment": "we need this to support empty targeting",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {}
+    },
+    {
+      "$ref": "#/definitions/anyRule"
     }
-  },
+  ],
   "definitions": {
-    "targeting": {
-      "title": "Targeting",
-      "description": "An expression returning a value which is coerced to a string to be used as a targeting key, or null (to fall back to defaultVariant). If targeting returns a value which is not a variant key, it's considered an error.",
-      "anyOf": [
-        {
-          "$comment": "we need this to support empty targeting",
-          "type": "object",
-          "additionalProperties": false,
-          "properties": {}
-        },
-        {
-          "$ref": "#/definitions/anyRule"
-        }
-      ]
-    },
     "primitive": {
       "oneOf": [
         {