Add readOnly annotations to JSON schema and filter in PyDABs

.wsignore

@@ -3,6 +3,7 @@
 .codegen/_openapi_sha
 .release_metadata.json
 bundle/schema/jsonschema.json
+bundle/schema/jsonschema_for_docs.json
 python/docs/images/databricks-logo.svg
 **/*.dist-info/METADATA
 **/*.dist-info/WHEEL

Makefile

@@ -133,6 +133,9 @@ snapshot-release:
 schema:
 	go run ./bundle/internal/schema ./bundle/internal/schema ./bundle/schema/jsonschema.json
 
+schema-for-docs:
+	go run ./bundle/internal/schema ./bundle/internal/schema ./bundle/schema/jsonschema_for_docs.json --docs
+
 docs:
 	go run ./bundle/docsgen ./bundle/internal/schema ./bundle/docsgen
 
@@ -171,7 +174,7 @@ generate:
 	$(GENKIT_BINARY) update-sdk
 
 
-.PHONY: lint lintfull tidy lintcheck fmt fmtfull test test-unit test-acc test-slow test-slow-unit test-slow-acc cover showcover build snapshot snapshot-release schema integration integration-short acc-cover acc-showcover docs ws wsfix links checks test-update test-update-templates generate-out-test-toml test-update-aws test-update-all generate-validation
+.PHONY: lint lintfull tidy lintcheck fmt fmtfull test test-unit test-acc test-slow test-slow-unit test-slow-acc cover showcover build snapshot snapshot-release schema schema-for-docs integration integration-short acc-cover acc-showcover docs ws wsfix links checks test-update test-update-templates generate-out-test-toml test-update-aws test-update-all generate-validation
 
 test-exp-aitools:
 	make test TEST_PACKAGES="./experimental/aitools/..." ACCEPTANCE_TEST_FILTER="TestAccept/apps"

bundle/internal/schema/annotations.go

@@ -139,7 +139,9 @@ func assignAnnotation(s *jsonschema.Schema, a annotation.Descriptor) {
 	}
 
 	if a.OutputOnly != nil && *a.OutputOnly {
-		s.FieldBehaviors = []string{"OUTPUT_ONLY"}
+		s.ReadOnly = true
+		s.DoNotSuggest = true
+		s.FieldBehaviors = append(s.FieldBehaviors, "OUTPUT_ONLY")
 	}
 
 	s.MarkdownDescription = convertLinksToAbsoluteUrl(a.MarkdownDescription)

bundle/internal/schema/annotations.yml

@@ -20,6 +20,12 @@ github.com/databricks/cli/bundle/config.Artifact:
     "markdown_description": |-
       Required if the artifact is a Python wheel. The type of the artifact. Valid values are `whl` and `jar`.
 github.com/databricks/cli/bundle/config.ArtifactFile:
+  "patched":
+    "description": |-
+      PLACEHOLDER
+  "remote_path":
+    "description": |-
+      PLACEHOLDER
   "source":
     "description": |-
       Required. The artifact source file.
@@ -42,14 +48,29 @@ github.com/databricks/cli/bundle/config.Bundle:
       The definition of the bundle deployment
     "markdown_description": |-
       The definition of the bundle deployment. For supported attributes see [\_](/dev-tools/bundles/deployment-modes.md).
+  "environment":
+    "description": |-
+      PLACEHOLDER
+  "force":
+    "description": |-
+      PLACEHOLDER
   "git":
     "description": |-
       The Git version control details that are associated with your bundle.
     "markdown_description": |-
       The Git version control details that are associated with your bundle. For supported attributes see [\_](/dev-tools/bundles/settings.md#git).
+  "mode":
+    "description": |-
+      PLACEHOLDER
   "name":
     "description": |-
       The name of the bundle.
+  "target":
+    "description": |-
+      PLACEHOLDER
+  "terraform":
+    "description": |-
+      PLACEHOLDER
   "uuid":
     "description": |-
       Reserved. A Universally Unique Identifier (UUID) for the bundle that uniquely identifies the bundle in internal Databricks systems. This is generated when a bundle project is initialized using a Databricks template (using the `databricks bundle init` command).
@@ -86,11 +107,20 @@ github.com/databricks/cli/bundle/config.Experimental:
     "description": |-
       Whether to use the legacy run_as behavior.
 github.com/databricks/cli/bundle/config.Git:
+  "actual_branch":
+    "description": |-
+      PLACEHOLDER
   "branch":
     "description": |-
       The Git branch name.
     "markdown_description": |-
       The Git branch name. See [\_](/dev-tools/bundles/settings.md#git).
+  "bundle_root_path":
+    "description": |-
+      PLACEHOLDER
+  "commit":
+    "description": |-
+      PLACEHOLDER
   "origin_url":
     "description": |-
       The origin URL of the repository.
@@ -396,6 +426,10 @@ github.com/databricks/cli/bundle/config.Target:
   "workspace":
     "description": |-
       The Databricks workspace for the target.
+github.com/databricks/cli/bundle/config.Terraform:
+  "exec_path":
+    "description": |-
+      PLACEHOLDER
 github.com/databricks/cli/bundle/config.Workspace:
   "artifact_path":
     "description": |-
@@ -424,6 +458,9 @@ github.com/databricks/cli/bundle/config.Workspace:
   "client_id":
     "description": |-
       The client ID for the workspace
+  "current_user":
+    "description": |-
+      PLACEHOLDER
   "experimental_is_unified_host":
     "description": |-
       Experimental feature flag to indicate if the host is a unified host
@@ -557,6 +594,9 @@ github.com/databricks/cli/bundle/config/resources.Dashboard:
   "dataset_schema":
     "description": |-
       Sets the default schema for all datasets in this dashboard. When set, this overrides the schema specified in individual dataset definitions.
+  "id":
+    "description": |-
+      PLACEHOLDER
 github.com/databricks/cli/bundle/config/resources.DashboardPermission:
   "group_name":
     "description": |-
@@ -692,6 +732,9 @@ github.com/databricks/cli/bundle/config/resources.SecretScope:
   "backend_type":
     "description": |-
       The backend type the scope will be created with. If not specified, will default to `DATABRICKS`
+  "id":
+    "description": |-
+      PLACEHOLDER
   "keyvault_metadata":
     "description": |-
       The metadata for the secret scope if the `backend_type` is `AZURE_KEYVAULT`
@@ -815,6 +858,9 @@ github.com/databricks/cli/bundle/config/variable.TargetVariable:
   "type":
     "description": |-
       The type of the variable.
+  "value":
+    "description": |-
+      PLACEHOLDER
 github.com/databricks/cli/bundle/config/variable.Variable:
   "_":
     "description": |-
@@ -835,6 +881,9 @@ github.com/databricks/cli/bundle/config/variable.Variable:
   "type":
     "description": |-
       The type of the variable.
+  "value":
+    "description": |-
+      PLACEHOLDER
 github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs:
   "service_principal_name":
     "description": |-