From f60ad32f07241b311192c1476e32ef8656e3c6f2 Mon Sep 17 00:00:00 2001
From: Ilya Kuznetsov <ilya.kuznetsov@databricks.com>
Date: Thu, 23 Jan 2025 12:11:44 +0100
Subject: [PATCH] Allow yaml-anchors in schema (#2200)

## Changes

Allows custom untyped fields in the root config in json-schema so it
doesn't highlight errors when using yaml-anchors.

Example use case:

```
tags: &job-tags
  environment: ${bundle.target}


resources:
  jobs:
    db1:
      tags:
        <<: *job-tags
    db1:
      tags:
        <<: *job-tags
```

One downside is that we don't highlight any unknown top-level properties
anymore (but they will still fail during CLI validation)

## Tests

Manually checked behavior in VSCode - it doesn't show validation error.
Also checked that other typed properties are still suggested
---
 bundle/internal/schema/main.go                        |  9 +++++++++
 .../schema/testdata/fail/unknown_top_level_field.yml  |  1 -
 bundle/internal/schema/testdata/pass/yaml_anchors.yml | 11 +++++++++++
 bundle/schema/jsonschema.json                         |  2 +-
 4 files changed, 21 insertions(+), 2 deletions(-)
 delete mode 100644 bundle/internal/schema/testdata/fail/unknown_top_level_field.yml
 create mode 100644 bundle/internal/schema/testdata/pass/yaml_anchors.yml

diff --git a/bundle/internal/schema/main.go b/bundle/internal/schema/main.go
index 39b8596563..38e099ece6 100644
--- a/bundle/internal/schema/main.go
+++ b/bundle/internal/schema/main.go
@@ -172,6 +172,15 @@ func generateSchema(workdir, outputFile string) {
 		a.addAnnotations,
 		addInterpolationPatterns,
 	})
+
+	// AdditionalProperties is set to an empty schema to allow non-typed keys used as yaml-anchors
+	// Example:
+	// some_anchor: &some_anchor
+	//   file_path: /some/path/
+	// workspace:
+	//   <<: *some_anchor
+	s.AdditionalProperties = jsonschema.Schema{}
+
 	if err != nil {
 		log.Fatal(err)
 	}
diff --git a/bundle/internal/schema/testdata/fail/unknown_top_level_field.yml b/bundle/internal/schema/testdata/fail/unknown_top_level_field.yml
deleted file mode 100644
index e8a8866bc2..0000000000
--- a/bundle/internal/schema/testdata/fail/unknown_top_level_field.yml
+++ /dev/null
@@ -1 +0,0 @@
-unknown: value
diff --git a/bundle/internal/schema/testdata/pass/yaml_anchors.yml b/bundle/internal/schema/testdata/pass/yaml_anchors.yml
new file mode 100644
index 0000000000..18749891dc
--- /dev/null
+++ b/bundle/internal/schema/testdata/pass/yaml_anchors.yml
@@ -0,0 +1,11 @@
+tags: &job-tags
+  environment: "some_environment"
+
+resources:
+  jobs:
+    db1:
+      tags:
+        <<: *job-tags
+    db2:
+      tags:
+        <<: *job-tags
diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json
index b3158792c8..4a3b568141 100644
--- a/bundle/schema/jsonschema.json
+++ b/bundle/schema/jsonschema.json
@@ -7269,5 +7269,5 @@
       "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Workspace"
     }
   },
-  "additionalProperties": false
+  "additionalProperties": {}
 }
\ No newline at end of file