Add template_variables to Notebooks v1 API spec (#1811)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v1/openapi.yaml

@@ -11287,6 +11287,12 @@ components:
           type: string
         status:
           $ref: "#/components/schemas/NotebookStatus"
+        template_variables:
+          description: List of template variables for this notebook.
+          items:
+            $ref: "#/components/schemas/NotebookTemplateVariable"
+          nullable: true
+          type: array
         time:
           $ref: "#/components/schemas/NotebookGlobalTime"
       required:
@@ -11506,6 +11512,12 @@ components:
           type: string
         status:
           $ref: "#/components/schemas/NotebookStatus"
+        template_variables:
+          description: List of template variables for this notebook.
+          items:
+            $ref: "#/components/schemas/NotebookTemplateVariable"
+          nullable: true
+          type: array
         time:
           $ref: "#/components/schemas/NotebookGlobalTime"
       required:
@@ -11548,6 +11560,128 @@ components:
       type: string
       x-enum-varnames:
         - PUBLISHED
+    NotebookTemplateVariable:
+      additionalProperties: false
+      description: Notebook template variable.
+      properties:
+        available_values:
+          description: The list of values that the template variable drop-down is limited to.
+          example: ["my-host", "host1", "host2"]
+          items:
+            description: Template variable value.
+            minLength: 1
+            type: string
+          nullable: true
+          type: array
+          uniqueItems: true
+        available_values_query:
+          $ref: "#/components/schemas/NotebookTemplateVariableAvailableValuesQuery"
+        data_source_mappings:
+          additionalProperties:
+            description: The value for the given data source.
+            type: string
+          description: Mapping of data source names to template variable values.
+          type: object
+        default:
+          deprecated: true
+          description: |-
+            (deprecated) The default value for the template variable on notebook load.
+            Cannot be used in conjunction with `defaults`.
+          example: my-host
+          nullable: true
+          type: string
+        defaults:
+          description: One or many default values for the template variable. Cannot be used in conjunction with `default`.
+          example: ["my-host-1", "my-host-2"]
+          items:
+            description: A default value for the template variable.
+            minLength: 1
+            type: string
+          type: array
+          uniqueItems: true
+        name:
+          description: The name of the variable.
+          example: host1
+          type: string
+        placement:
+          description: The placement of the template variable in the notebook.
+          example: global
+          type: string
+        prefix:
+          description: The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
+          example: host
+          nullable: true
+          type: string
+        type:
+          description: The type of the template variable.
+          example: tag
+          type: string
+      required:
+        - name
+      type: object
+    NotebookTemplateVariableAvailableValuesQuery:
+      description: Query used to dynamically populate the list of available values for the template variable.
+      oneOf:
+        - $ref: "#/components/schemas/NotebookTemplateVariableAvailableValuesQueryLogRumSpans"
+        - $ref: "#/components/schemas/NotebookTemplateVariableAvailableValuesQueryMetrics"
+    NotebookTemplateVariableAvailableValuesQueryGroupBy:
+      additionalProperties: false
+      description: A group-by facet for an available values query.
+      properties:
+        facet:
+          description: The facet name to group by.
+          example: host
+          type: string
+      required:
+        - facet
+      type: object
+    NotebookTemplateVariableAvailableValuesQueryLogRumSpans:
+      additionalProperties: false
+      description: Available values query for logs, RUM, or spans data sources.
+      properties:
+        data_source:
+          description: The data source for the query. Must be one of `logs`, `rum`, or `spans`.
+          example: logs
+          type: string
+        group_by:
+          description: Group-by fields for the query.
+          items:
+            $ref: "#/components/schemas/NotebookTemplateVariableAvailableValuesQueryGroupBy"
+          type: array
+        search:
+          $ref: "#/components/schemas/NotebookTemplateVariableAvailableValuesQuerySearch"
+      required:
+        - data_source
+        - search
+        - group_by
+      type: object
+    NotebookTemplateVariableAvailableValuesQueryMetrics:
+      additionalProperties: false
+      description: Available values query for the metrics data source.
+      properties:
+        data_source:
+          description: The data source for the query. Must be `metrics`.
+          example: metrics
+          type: string
+        query:
+          description: The metrics query string.
+          example: "avg:system.cpu.user{*} by {host}"
+          type: string
+      required:
+        - data_source
+        - query
+      type: object
+    NotebookTemplateVariableAvailableValuesQuerySearch:
+      additionalProperties: false
+      description: Search parameters for an available values query.
+      properties:
+        query:
+          description: The search query string.
+          example: "service:web"
+          type: string
+      required:
+        - query
+      type: object
     NotebookTimeseriesCellAttributes:
       description: The attributes of a notebook `timeseries` cell.
       properties:
@@ -11613,6 +11747,12 @@ components:
           type: string
         status:
           $ref: "#/components/schemas/NotebookStatus"
+        template_variables:
+          description: List of template variables for this notebook.
+          items:
+            $ref: "#/components/schemas/NotebookTemplateVariable"
+          nullable: true
+          type: array
         time:
           $ref: "#/components/schemas/NotebookGlobalTime"
       required:
@@ -11689,6 +11829,12 @@ components:
           type: string
         status:
           $ref: "#/components/schemas/NotebookStatus"
+        template_variables:
+          description: List of template variables for this notebook.
+          items:
+            $ref: "#/components/schemas/NotebookTemplateVariable"
+          nullable: true
+          type: array
         time:
           $ref: "#/components/schemas/NotebookGlobalTime"
       required:

src/datadogV1/model/mod.rs

@@ -1454,6 +1454,18 @@ pub mod model_notebook_metadata_type;
 pub use self::model_notebook_metadata_type::NotebookMetadataType;
 pub mod model_notebook_status;
 pub use self::model_notebook_status::NotebookStatus;
+pub mod model_notebook_template_variable;
+pub use self::model_notebook_template_variable::NotebookTemplateVariable;
+pub mod model_notebook_template_variable_available_values_query_log_rum_spans;
+pub use self::model_notebook_template_variable_available_values_query_log_rum_spans::NotebookTemplateVariableAvailableValuesQueryLogRumSpans;
+pub mod model_notebook_template_variable_available_values_query_group_by;
+pub use self::model_notebook_template_variable_available_values_query_group_by::NotebookTemplateVariableAvailableValuesQueryGroupBy;
+pub mod model_notebook_template_variable_available_values_query_search;
+pub use self::model_notebook_template_variable_available_values_query_search::NotebookTemplateVariableAvailableValuesQuerySearch;
+pub mod model_notebook_template_variable_available_values_query_metrics;
+pub use self::model_notebook_template_variable_available_values_query_metrics::NotebookTemplateVariableAvailableValuesQueryMetrics;
+pub mod model_notebook_template_variable_available_values_query;
+pub use self::model_notebook_template_variable_available_values_query::NotebookTemplateVariableAvailableValuesQuery;
 pub mod model_notebook_global_time;
 pub use self::model_notebook_global_time::NotebookGlobalTime;
 pub mod model_notebook_resource_type;

src/datadogV1/model/model_notebook_create_data_attributes.rs

@@ -23,6 +23,13 @@ pub struct NotebookCreateDataAttributes {
     /// Publication status of the notebook. For now, always "published".
     #[serde(rename = "status")]
     pub status: Option<crate::datadogV1::model::NotebookStatus>,
+    /// List of template variables for this notebook.
+    #[serde(
+        rename = "template_variables",
+        default,
+        with = "::serde_with::rust::double_option"
+    )]
+    pub template_variables: Option<Option<Vec<crate::datadogV1::model::NotebookTemplateVariable>>>,
     /// Notebook global timeframe.
     #[serde(rename = "time")]
     pub time: crate::datadogV1::model::NotebookGlobalTime,
@@ -44,6 +51,7 @@ impl NotebookCreateDataAttributes {
             metadata: None,
             name,
             status: None,
+            template_variables: None,
             time,
             additional_properties: std::collections::BTreeMap::new(),
             _unparsed: false,
@@ -60,6 +68,14 @@ impl NotebookCreateDataAttributes {
         self
     }
 
+    pub fn template_variables(
+        mut self,
+        value: Option<Vec<crate::datadogV1::model::NotebookTemplateVariable>>,
+    ) -> Self {
+        self.template_variables = Some(value);
+        self
+    }
+
     pub fn additional_properties(
         mut self,
         value: std::collections::BTreeMap<String, serde_json::Value>,
@@ -91,6 +107,9 @@ impl<'de> Deserialize<'de> for NotebookCreateDataAttributes {
                 let mut metadata: Option<crate::datadogV1::model::NotebookMetadata> = None;
                 let mut name: Option<String> = None;
                 let mut status: Option<crate::datadogV1::model::NotebookStatus> = None;
+                let mut template_variables: Option<
+                    Option<Vec<crate::datadogV1::model::NotebookTemplateVariable>>,
+                > = None;
                 let mut time: Option<crate::datadogV1::model::NotebookGlobalTime> = None;
                 let mut additional_properties: std::collections::BTreeMap<
                     String,
@@ -128,6 +147,10 @@ impl<'de> Deserialize<'de> for NotebookCreateDataAttributes {
                                 }
                             }
                         }
+                        "template_variables" => {
+                            template_variables =
+                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         "time" => {
                             time = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                             if let Some(ref _time) = time {
@@ -157,6 +180,7 @@ impl<'de> Deserialize<'de> for NotebookCreateDataAttributes {
                     metadata,
                     name,
                     status,
+                    template_variables,
                     time,
                     additional_properties,
                     _unparsed,

src/datadogV1/model/model_notebook_response_data_attributes.rs

@@ -32,6 +32,13 @@ pub struct NotebookResponseDataAttributes {
     /// Publication status of the notebook. For now, always "published".
     #[serde(rename = "status")]
     pub status: Option<crate::datadogV1::model::NotebookStatus>,
+    /// List of template variables for this notebook.
+    #[serde(
+        rename = "template_variables",
+        default,
+        with = "::serde_with::rust::double_option"
+    )]
+    pub template_variables: Option<Option<Vec<crate::datadogV1::model::NotebookTemplateVariable>>>,
     /// Notebook global timeframe.
     #[serde(rename = "time")]
     pub time: crate::datadogV1::model::NotebookGlobalTime,
@@ -56,6 +63,7 @@ impl NotebookResponseDataAttributes {
             modified: None,
             name,
             status: None,
+            template_variables: None,
             time,
             additional_properties: std::collections::BTreeMap::new(),
             _unparsed: false,
@@ -87,6 +95,14 @@ impl NotebookResponseDataAttributes {
         self
     }
 
+    pub fn template_variables(
+        mut self,
+        value: Option<Vec<crate::datadogV1::model::NotebookTemplateVariable>>,
+    ) -> Self {
+        self.template_variables = Some(value);
+        self
+    }
+
     pub fn additional_properties(
         mut self,
         value: std::collections::BTreeMap<String, serde_json::Value>,
@@ -120,6 +136,9 @@ impl<'de> Deserialize<'de> for NotebookResponseDataAttributes {
                 let mut modified: Option<chrono::DateTime<chrono::Utc>> = None;
                 let mut name: Option<String> = None;
                 let mut status: Option<crate::datadogV1::model::NotebookStatus> = None;
+                let mut template_variables: Option<
+                    Option<Vec<crate::datadogV1::model::NotebookTemplateVariable>>,
+                > = None;
                 let mut time: Option<crate::datadogV1::model::NotebookGlobalTime> = None;
                 let mut additional_properties: std::collections::BTreeMap<
                     String,
@@ -175,6 +194,10 @@ impl<'de> Deserialize<'de> for NotebookResponseDataAttributes {
                                 }
                             }
                         }
+                        "template_variables" => {
+                            template_variables =
+                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         "time" => {
                             time = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                             if let Some(ref _time) = time {
@@ -207,6 +230,7 @@ impl<'de> Deserialize<'de> for NotebookResponseDataAttributes {
                     modified,
                     name,
                     status,
+                    template_variables,
                     time,
                     additional_properties,
                     _unparsed,