steve/databricks-cli
steve
/
databricks-cli
mirror of https://github.com/databricks/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
databricks-cli/bundle/schema
History
kartikgupta-db 0b222358ca
Allow including fields with ignored tags in the bundle schema output 		2024-01-17 10:37:49 +01:00
..
docs Upgrade Go SDK to 0.27.0 (#1064) 2023-12-14 08:15:00 +00:00
README.md Move bundle schema update to an internal module (#1012) 2023-12-06 10:45:18 +00:00
docs.go Allow including fields with ignored tags in the bundle schema output 2024-01-17 10:37:49 +01:00
docs_test.go Add JSON schema validation for input template parameters (#598) 2023-08-01 14:09:27 +00:00
openapi.go Support Unity Catalog Registered Models in bundles (#846) 2023-10-16 15:32:49 +00:00
openapi_test.go Add JSON schema validation for input template parameters (#598) 2023-08-01 14:09:27 +00:00
schema.go Allow including fields with ignored tags in the bundle schema output 2024-01-17 10:37:49 +01:00
schema_test.go Allow including fields with ignored tags in the bundle schema output 2024-01-17 10:37:49 +01:00
tracker.go Use tracker for reference loop tracking (#252) 2023-03-16 12:57:57 +01:00

README.md

Overview

docs/bundle_descriptions.json contains both autogenerated as well as manually written descriptions for the json schema. Specifically

  1. resources : almost all descriptions are autogenerated from the OpenAPI spec
  2. targets : almost all descriptions are copied over from root level entities (eg: bundle, artifacts)
  3. bundle : manually editted
  4. include : manually editted
  5. workspace : manually editted
  6. artifacts : manually editted

These descriptions are rendered in the inline documentation in an IDE

SOP: Add schema descriptions for new fields in bundle config

Manually edit bundle_descriptions.json to add your descriptions. Note that the descriptions in resources block is generated from the OpenAPI spec, and thus any changes there will be overwritten.