From ab7ae0f5d3ffbf4bbb404be28a71eb1f30f3c654 Mon Sep 17 00:00:00 2001 From: Ilya Kuznetsov Date: Tue, 25 Feb 2025 10:56:35 +0100 Subject: [PATCH] Add descriptions --- bundle/docsgen/output/resources.md | 38 +++++++++---------- .../schema/annotations_openapi_overrides.yml | 12 +++--- bundle/schema/jsonschema.json | 6 +++ 3 files changed, 31 insertions(+), 25 deletions(-) diff --git a/bundle/docsgen/output/resources.md b/bundle/docsgen/output/resources.md index c1cb483d9..e1b8f7c30 100644 --- a/bundle/docsgen/output/resources.md +++ b/bundle/docsgen/output/resources.md @@ -899,11 +899,11 @@ Defines values necessary to configure and run Azure Log Analytics agent - - `log_analytics_primary_key` - String - - + - The primary key for the Azure Log Analytics agent configuration - - `log_analytics_workspace_id` - String - - + - The workspace ID for the Azure Log Analytics agent configuration ::: @@ -1115,7 +1115,7 @@ The configuration for storing init scripts. Any number of destinations can be sp - - `abfss` - Map - - See [\_](#clustersnameinit_scriptsabfss). + - Contains the Azure Data Lake Storage destination path. See [\_](#clustersnameinit_scriptsabfss). - - `dbfs` - Map @@ -1148,7 +1148,7 @@ The configuration for storing init scripts. Any number of destinations can be sp **`Type: Map`** - +Contains the Azure Data Lake Storage destination path @@ -1927,7 +1927,7 @@ In this minimal environment spec, only pip dependencies are supported. - - `dependencies` - Sequence - - + - List of pip dependencies, as supported by the version of pip in this environment. ::: @@ -2378,11 +2378,11 @@ Defines values necessary to configure and run Azure Log Analytics agent - - `log_analytics_primary_key` - String - - + - The primary key for the Azure Log Analytics agent configuration - - `log_analytics_workspace_id` - String - - + - The workspace ID for the Azure Log Analytics agent configuration ::: @@ -2594,7 +2594,7 @@ The configuration for storing init scripts. Any number of destinations can be sp - - `abfss` - Map - - See [\_](#jobsnamejob_clustersnew_clusterinit_scriptsabfss). + - Contains the Azure Data Lake Storage destination path. See [\_](#jobsnamejob_clustersnew_clusterinit_scriptsabfss). - - `dbfs` - Map @@ -2627,7 +2627,7 @@ The configuration for storing init scripts. Any number of destinations can be sp **`Type: Map`** - +Contains the Azure Data Lake Storage destination path @@ -3799,11 +3799,11 @@ Defines values necessary to configure and run Azure Log Analytics agent - - `log_analytics_primary_key` - String - - + - The primary key for the Azure Log Analytics agent configuration - - `log_analytics_workspace_id` - String - - + - The workspace ID for the Azure Log Analytics agent configuration ::: @@ -4015,7 +4015,7 @@ The configuration for storing init scripts. Any number of destinations can be sp - - `abfss` - Map - - See [\_](#jobsnametasksnew_clusterinit_scriptsabfss). + - Contains the Azure Data Lake Storage destination path. See [\_](#jobsnametasksnew_clusterinit_scriptsabfss). - - `dbfs` - Map @@ -4048,7 +4048,7 @@ The configuration for storing init scripts. Any number of destinations can be sp **`Type: Map`** - +Contains the Azure Data Lake Storage destination path @@ -6768,11 +6768,11 @@ Defines values necessary to configure and run Azure Log Analytics agent - - `log_analytics_primary_key` - String - - + - The primary key for the Azure Log Analytics agent configuration - - `log_analytics_workspace_id` - String - - + - The workspace ID for the Azure Log Analytics agent configuration ::: @@ -6935,7 +6935,7 @@ The configuration for storing init scripts. Any number of destinations can be sp - - `abfss` - Map - - See [\_](#pipelinesnameclustersinit_scriptsabfss). + - Contains the Azure Data Lake Storage destination path. See [\_](#pipelinesnameclustersinit_scriptsabfss). - - `dbfs` - Map @@ -6968,7 +6968,7 @@ The configuration for storing init scripts. Any number of destinations can be sp **`Type: Map`** - +Contains the Azure Data Lake Storage destination path @@ -8011,7 +8011,7 @@ Configuration for monitoring inference logs. - - `granularities` - Sequence - - + - Granularities for aggregating data into time windows based on their timestamp. Valid values are 5 minutes, 30 minutes, 1 hour, 1 day, n weeks, 1 month, or 1 year. - - `label_col` - String @@ -8159,7 +8159,7 @@ Configuration for monitoring time series tables. - - `granularities` - Sequence - - + - Granularities for aggregating data into time windows based on their timestamp. Valid values are 5 minutes, 30 minutes, 1 hour, 1 day, n weeks, 1 month, or 1 year. - - `timestamp_col` - String diff --git a/bundle/internal/schema/annotations_openapi_overrides.yml b/bundle/internal/schema/annotations_openapi_overrides.yml index 55ac4fdd4..36aa4f905 100644 --- a/bundle/internal/schema/annotations_openapi_overrides.yml +++ b/bundle/internal/schema/annotations_openapi_overrides.yml @@ -569,23 +569,23 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedModelInput: github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo: "abfss": "description": |- - PLACEHOLDER + Contains the Azure Data Lake Storage destination path github.com/databricks/databricks-sdk-go/service/compute.Environment: "dependencies": "description": |- - PLACEHOLDER + List of pip dependencies, as supported by the version of pip in this environment. github.com/databricks/databricks-sdk-go/service/catalog.MonitorInferenceLog: "granularities": "description": |- - PLACEHOLDER + Granularities for aggregating data into time windows based on their timestamp. Valid values are 5 minutes, 30 minutes, 1 hour, 1 day, n weeks, 1 month, or 1 year. github.com/databricks/databricks-sdk-go/service/catalog.MonitorTimeSeries: "granularities": "description": |- - PLACEHOLDER + Granularities for aggregating data into time windows based on their timestamp. Valid values are 5 minutes, 30 minutes, 1 hour, 1 day, n weeks, 1 month, or 1 year. github.com/databricks/databricks-sdk-go/service/compute.LogAnalyticsInfo: "log_analytics_primary_key": "description": |- - PLACEHOLDER + The primary key for the Azure Log Analytics agent configuration "log_analytics_workspace_id": "description": |- - PLACEHOLDER + The workspace ID for the Azure Log Analytics agent configuration diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index 2cb2cd7b5..2ef2efbfd 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -2094,6 +2094,7 @@ "type": "object", "properties": { "granularities": { + "description": "Granularities for aggregating data into time windows based on their timestamp. Valid values are 5 minutes, 30 minutes, 1 hour, 1 day, n weeks, 1 month, or 1 year.", "$ref": "#/$defs/slice/string" }, "label_col": { @@ -2250,6 +2251,7 @@ "type": "object", "properties": { "granularities": { + "description": "Granularities for aggregating data into time windows based on their timestamp. Valid values are 5 minutes, 30 minutes, 1 hour, 1 day, n weeks, 1 month, or 1 year.", "$ref": "#/$defs/slice/string" }, "timestamp_col": { @@ -2730,6 +2732,7 @@ "$ref": "#/$defs/string" }, "dependencies": { + "description": "List of pip dependencies, as supported by the version of pip in this environment.", "$ref": "#/$defs/slice/string" } }, @@ -2825,6 +2828,7 @@ "type": "object", "properties": { "abfss": { + "description": "Contains the Azure Data Lake Storage destination path", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Adlsgen2Info" }, "dbfs": { @@ -2932,9 +2936,11 @@ "type": "object", "properties": { "log_analytics_primary_key": { + "description": "The primary key for the Azure Log Analytics agent configuration", "$ref": "#/$defs/string" }, "log_analytics_workspace_id": { + "description": "The workspace ID for the Azure Log Analytics agent configuration", "$ref": "#/$defs/string" } },