github.com/databricks/cli@v0.203.0/bundle/schema/README.md (about)

     1  ### Overview
     2  
     3  `docs/bundle_descriptions.json` contains both autogenerated as well as manually written
     4  descriptions for the json schema. Specifically
     5  1. `resources` : almost all descriptions are autogenerated from the OpenAPI spec
     6  2. `environments` : almost all descriptions are copied over from root level entities (eg: `bundle`, `artifacts`)
     7  3. `bundle` : manually editted
     8  4. `include` : manually editted
     9  5. `workspace` : manually editted
    10  6. `artifacts` : manually editted
    11  
    12  These descriptions are rendered in the inline documentation in an IDE
    13  
    14  ### SOP: Add schema descriptions for new fields in bundle config
    15  
    16  1. You can autogenerate empty descriptions for the new fields by running
    17  `databricks bundle schema --only-docs > ~/databricks/bundle/schema/docs/bundle_descriptions.json`
    18  2. Manually edit bundle_descriptions.json to add your descriptions
    19  3. Build again to embed the new `bundle_descriptions.json` into the binary (`go build`)
    20  4. Again run `databricks bundle schema --only-docs > ~/databricks/bundle/schema/docs/bundle_descriptions.json` to copy over any applicable descriptions to `environments`
    21  5. push to repo
    22  
    23  
    24  ### SOP: Update descriptions in resources from a newer openapi spec
    25  
    26  1. Run `databricks bundle schema --only-docs --openapi PATH_TO_SPEC > ~/databricks/bundle/schema/docs/bundle_descriptions.json`
    27  2. push to repo