Update template variable schemas with type field in dashboards and shared dashboards endpoints for group by template variables

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-06-30 10:29:37.915889",
-            "spec_repo_commit": "be63084a"
+            "regenerated": "2025-06-30 17:05:05.986606",
+            "spec_repo_commit": "d8e7ee77"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-06-30 10:29:37.934362",
-            "spec_repo_commit": "be63084a"
+            "regenerated": "2025-06-30 17:05:06.003684",
+            "spec_repo_commit": "d8e7ee77"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -1550,6 +1550,13 @@ components:
           example: host
           nullable: true
           type: string
+        type:
+          description: The type of variable. This is to differentiate between filter
+            variables (interpolated in query) and group by variables (interpolated
+            into group by).
+          example: group
+          nullable: true
+          type: string
       required:
       - name
       type: object
@@ -12578,6 +12585,12 @@ components:
         prefix:
           description: The tag/attribute key associated with the template variable.
           type: string
+        type:
+          description: The type of variable. This is to differentiate between filter
+            variables (interpolated in query) and group by variables (interpolated
+            into group by).
+          nullable: true
+          type: string
         visible_tags:
           description: List of visible tag values on the shared dashboard.
           items:

examples/v1/dashboards/CreateDashboard_1751391372.java

@@ -0,0 +1,59 @@
+// Create a new dashboard with template variable type field returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v1.api.DashboardsApi;
+import com.datadog.api.client.v1.model.Dashboard;
+import com.datadog.api.client.v1.model.DashboardLayoutType;
+import com.datadog.api.client.v1.model.DashboardReflowType;
+import com.datadog.api.client.v1.model.DashboardTemplateVariable;
+import com.datadog.api.client.v1.model.HostMapRequest;
+import com.datadog.api.client.v1.model.HostMapWidgetDefinition;
+import com.datadog.api.client.v1.model.HostMapWidgetDefinitionRequests;
+import com.datadog.api.client.v1.model.HostMapWidgetDefinitionType;
+import com.datadog.api.client.v1.model.Widget;
+import com.datadog.api.client.v1.model.WidgetDefinition;
+import java.util.Arrays;
+import java.util.Collections;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    DashboardsApi apiInstance = new DashboardsApi(defaultClient);
+
+    Dashboard body =
+        new Dashboard()
+            .description(null)
+            .layoutType(DashboardLayoutType.ORDERED)
+            .reflowType(DashboardReflowType.AUTO)
+            .templateVariables(
+                Collections.singletonList(
+                    new DashboardTemplateVariable()
+                        .availableValues(Arrays.asList("service", "datacenter", "env"))
+                        .defaults(Arrays.asList("service", "datacenter"))
+                        .name("group_by_var")
+                        .type("group")))
+            .title("")
+            .widgets(
+                Collections.singletonList(
+                    new Widget()
+                        .definition(
+                            new WidgetDefinition(
+                                new HostMapWidgetDefinition()
+                                    .requests(
+                                        new HostMapWidgetDefinitionRequests()
+                                            .fill(new HostMapRequest().q("avg:system.cpu.user{*}")))
+                                    .type(HostMapWidgetDefinitionType.HOSTMAP)))));
+
+    try {
+      Dashboard result = apiInstance.createDashboard(body);
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling DashboardsApi#createDashboard");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v1/dashboards/CreatePublicDashboard_1668947073.java

@@ -0,0 +1,49 @@
+// Create a shared dashboard with a group template variable returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v1.api.DashboardsApi;
+import com.datadog.api.client.v1.model.DashboardGlobalTime;
+import com.datadog.api.client.v1.model.DashboardGlobalTimeLiveSpan;
+import com.datadog.api.client.v1.model.DashboardShareType;
+import com.datadog.api.client.v1.model.DashboardType;
+import com.datadog.api.client.v1.model.SelectableTemplateVariableItems;
+import com.datadog.api.client.v1.model.SharedDashboard;
+import java.util.Arrays;
+import java.util.Collections;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    DashboardsApi apiInstance = new DashboardsApi(defaultClient);
+
+    // there is a valid "dashboard" in the system
+    String DASHBOARD_ID = System.getenv("DASHBOARD_ID");
+
+    SharedDashboard body =
+        new SharedDashboard()
+            .dashboardId(DASHBOARD_ID)
+            .dashboardType(DashboardType.CUSTOM_TIMEBOARD)
+            .shareType(DashboardShareType.OPEN)
+            .globalTime(
+                new DashboardGlobalTime().liveSpan(DashboardGlobalTimeLiveSpan.PAST_ONE_HOUR))
+            .selectableTemplateVars(
+                Collections.singletonList(
+                    new SelectableTemplateVariableItems()
+                        .defaultValue("*")
+                        .name("group_by_var")
+                        .type("group")
+                        .visibleTags(Arrays.asList("selectableValue1", "selectableValue2"))));
+
+    try {
+      SharedDashboard result = apiInstance.createPublicDashboard(body);
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling DashboardsApi#createPublicDashboard");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v1/dashboards/UpdatePublicDashboard_1708268778.java

@@ -0,0 +1,48 @@
+// Update a shared dashboard with selectable_template_vars returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v1.api.DashboardsApi;
+import com.datadog.api.client.v1.model.DashboardGlobalTimeLiveSpan;
+import com.datadog.api.client.v1.model.DashboardShareType;
+import com.datadog.api.client.v1.model.SelectableTemplateVariableItems;
+import com.datadog.api.client.v1.model.SharedDashboard;
+import com.datadog.api.client.v1.model.SharedDashboardUpdateRequest;
+import com.datadog.api.client.v1.model.SharedDashboardUpdateRequestGlobalTime;
+import java.util.Arrays;
+import java.util.Collections;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    DashboardsApi apiInstance = new DashboardsApi(defaultClient);
+
+    // there is a valid "shared_dashboard" in the system
+    String SHARED_DASHBOARD_TOKEN = System.getenv("SHARED_DASHBOARD_TOKEN");
+
+    SharedDashboardUpdateRequest body =
+        new SharedDashboardUpdateRequest()
+            .globalTime(
+                new SharedDashboardUpdateRequestGlobalTime()
+                    .liveSpan(DashboardGlobalTimeLiveSpan.PAST_FIFTEEN_MINUTES))
+            .shareType(DashboardShareType.OPEN)
+            .selectableTemplateVars(
+                Collections.singletonList(
+                    new SelectableTemplateVariableItems()
+                        .defaultValue("*")
+                        .name("group_by_var")
+                        .type("group")
+                        .visibleTags(Arrays.asList("selectableValue1", "selectableValue2"))));
+
+    try {
+      SharedDashboard result = apiInstance.updatePublicDashboard(SHARED_DASHBOARD_TOKEN, body);
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling DashboardsApi#updatePublicDashboard");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

src/main/java/com/datadog/api/client/v1/model/DashboardTemplateVariable.java

@@ -26,7 +26,8 @@
   DashboardTemplateVariable.JSON_PROPERTY_DEFAULT,
   DashboardTemplateVariable.JSON_PROPERTY_DEFAULTS,
   DashboardTemplateVariable.JSON_PROPERTY_NAME,
-  DashboardTemplateVariable.JSON_PROPERTY_PREFIX
+  DashboardTemplateVariable.JSON_PROPERTY_PREFIX,
+  DashboardTemplateVariable.JSON_PROPERTY_TYPE
 })
 @jakarta.annotation.Generated(
     value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
@@ -47,6 +48,9 @@ public class DashboardTemplateVariable {
   public static final String JSON_PROPERTY_PREFIX = "prefix";
   private JsonNullable<String> prefix = JsonNullable.<String>undefined();
 
+  public static final String JSON_PROPERTY_TYPE = "type";
+  private JsonNullable<String> type = JsonNullable.<String>undefined();
+
   public DashboardTemplateVariable() {}
 
   @JsonCreator
@@ -216,6 +220,38 @@ public void setPrefix(String prefix) {
     this.prefix = JsonNullable.<String>of(prefix);
   }
 
+  public DashboardTemplateVariable type(String type) {
+    this.type = JsonNullable.<String>of(type);
+    return this;
+  }
+
+  /**
+   * The type of variable. This is to differentiate between filter variables (interpolated in query)
+   * and group by variables (interpolated into group by).
+   *
+   * @return type
+   */
+  @jakarta.annotation.Nullable
+  @JsonIgnore
+  public String getType() {
+    return type.orElse(null);
+  }
+
+  @JsonProperty(JSON_PROPERTY_TYPE)
+  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  public JsonNullable<String> getType_JsonNullable() {
+    return type;
+  }
+
+  @JsonProperty(JSON_PROPERTY_TYPE)
+  public void setType_JsonNullable(JsonNullable<String> type) {
+    this.type = type;
+  }
+
+  public void setType(String type) {
+    this.type = JsonNullable.<String>of(type);
+  }
+
   /**
    * A container for additional, undeclared properties. This is a holder for any undeclared
    * properties as specified with the 'additionalProperties' keyword in the OAS document.
@@ -277,13 +313,15 @@ public boolean equals(Object o) {
         && Objects.equals(this.defaults, dashboardTemplateVariable.defaults)
         && Objects.equals(this.name, dashboardTemplateVariable.name)
         && Objects.equals(this.prefix, dashboardTemplateVariable.prefix)
+        && Objects.equals(this.type, dashboardTemplateVariable.type)
         && Objects.equals(
             this.additionalProperties, dashboardTemplateVariable.additionalProperties);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(availableValues, _default, defaults, name, prefix, additionalProperties);
+    return Objects.hash(
+        availableValues, _default, defaults, name, prefix, type, additionalProperties);
   }
 
   @Override
@@ -295,6 +333,7 @@ public String toString() {
     sb.append("    defaults: ").append(toIndentedString(defaults)).append("\n");
     sb.append("    name: ").append(toIndentedString(name)).append("\n");
     sb.append("    prefix: ").append(toIndentedString(prefix)).append("\n");
+    sb.append("    type: ").append(toIndentedString(type)).append("\n");
     sb.append("    additionalProperties: ")
         .append(toIndentedString(additionalProperties))
         .append("\n");

src/main/java/com/datadog/api/client/v1/model/SelectableTemplateVariableItems.java

@@ -27,6 +27,7 @@
   SelectableTemplateVariableItems.JSON_PROPERTY_DEFAULT_VALUE,
   SelectableTemplateVariableItems.JSON_PROPERTY_NAME,
   SelectableTemplateVariableItems.JSON_PROPERTY_PREFIX,
+  SelectableTemplateVariableItems.JSON_PROPERTY_TYPE,
   SelectableTemplateVariableItems.JSON_PROPERTY_VISIBLE_TAGS
 })
 @jakarta.annotation.Generated(
@@ -42,6 +43,9 @@ public class SelectableTemplateVariableItems {
   public static final String JSON_PROPERTY_PREFIX = "prefix";
   private String prefix;
 
+  public static final String JSON_PROPERTY_TYPE = "type";
+  private JsonNullable<String> type = JsonNullable.<String>undefined();
+
   public static final String JSON_PROPERTY_VISIBLE_TAGS = "visible_tags";
   private JsonNullable<List<String>> visibleTags = JsonNullable.<List<String>>undefined();
 
@@ -108,6 +112,38 @@ public void setPrefix(String prefix) {
     this.prefix = prefix;
   }
 
+  public SelectableTemplateVariableItems type(String type) {
+    this.type = JsonNullable.<String>of(type);
+    return this;
+  }
+
+  /**
+   * The type of variable. This is to differentiate between filter variables (interpolated in query)
+   * and group by variables (interpolated into group by).
+   *
+   * @return type
+   */
+  @jakarta.annotation.Nullable
+  @JsonIgnore
+  public String getType() {
+    return type.orElse(null);
+  }
+
+  @JsonProperty(JSON_PROPERTY_TYPE)
+  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  public JsonNullable<String> getType_JsonNullable() {
+    return type;
+  }
+
+  @JsonProperty(JSON_PROPERTY_TYPE)
+  public void setType_JsonNullable(JsonNullable<String> type) {
+    this.type = type;
+  }
+
+  public void setType(String type) {
+    this.type = JsonNullable.<String>of(type);
+  }
+
   public SelectableTemplateVariableItems visibleTags(List<String> visibleTags) {
     this.visibleTags = JsonNullable.<List<String>>of(visibleTags);
     return this;
@@ -211,14 +247,15 @@ public boolean equals(Object o) {
     return Objects.equals(this.defaultValue, selectableTemplateVariableItems.defaultValue)
         && Objects.equals(this.name, selectableTemplateVariableItems.name)
         && Objects.equals(this.prefix, selectableTemplateVariableItems.prefix)
+        && Objects.equals(this.type, selectableTemplateVariableItems.type)
         && Objects.equals(this.visibleTags, selectableTemplateVariableItems.visibleTags)
         && Objects.equals(
             this.additionalProperties, selectableTemplateVariableItems.additionalProperties);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(defaultValue, name, prefix, visibleTags, additionalProperties);
+    return Objects.hash(defaultValue, name, prefix, type, visibleTags, additionalProperties);
   }
 
   @Override
@@ -228,6 +265,7 @@ public String toString() {
     sb.append("    defaultValue: ").append(toIndentedString(defaultValue)).append("\n");
     sb.append("    name: ").append(toIndentedString(name)).append("\n");
     sb.append("    prefix: ").append(toIndentedString(prefix)).append("\n");
+    sb.append("    type: ").append(toIndentedString(type)).append("\n");
     sb.append("    visibleTags: ").append(toIndentedString(visibleTags)).append("\n");
     sb.append("    additionalProperties: ")
         .append(toIndentedString(additionalProperties))

src/test/resources/cassettes/features/v1/Create_a_new_dashboard_with_template_variable_type_field_returns_OK_response.freeze

@@ -0,0 +1 @@
+2025-06-30T15:47:16.966Z