Add powerpack widget to dashboard schema

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-02 18:58:13.273150",
-            "spec_repo_commit": "aee9e14a"
+            "regenerated": "2023-10-04 17:33:04.961391",
+            "spec_repo_commit": "adf28ce4"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-02 18:58:13.288015",
-            "spec_repo_commit": "aee9e14a"
+            "regenerated": "2023-10-04 17:33:04.978253",
+            "spec_repo_commit": "adf28ce4"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -9085,6 +9085,86 @@ components:
       maxItems: 2
       minItems: 2
       type: array
+    PowerpackTemplateVariableContents:
+      description: Powerpack template variable contents.
+      properties:
+        name:
+          description: The name of the variable.
+          example: host1
+          type: string
+        prefix:
+          description: The tag prefix associated with the variable.
+          type: string
+        values:
+          description: One or many template variable values within the saved view,
+            which will be unioned together using `OR` if more than one is specified.
+          example:
+          - my-host
+          - host1
+          - host2
+          items:
+            description: One or more possible values of the template variable.
+            minLength: 1
+            type: string
+          type: array
+      required:
+      - name
+      - values
+      type: object
+    PowerpackTemplateVariables:
+      description: Powerpack template variables.
+      properties:
+        controlled_by_powerpack:
+          description: Template variables controlled at the powerpack level.
+          items:
+            $ref: '#/components/schemas/PowerpackTemplateVariableContents'
+          type: array
+        controlled_externally:
+          description: Template variables controlled by the external resource, such
+            as the dashboard this powerpack is on.
+          items:
+            $ref: '#/components/schemas/PowerpackTemplateVariableContents'
+          type: array
+      type: object
+    PowerpackWidgetDefinition:
+      description: The powerpack widget allows you to keep similar graphs together
+        on your timeboard. Each group has a custom header, can hold one to many graphs,
+        and is collapsible.
+      properties:
+        background_color:
+          description: Background color of the powerpack title.
+          type: string
+        banner_img:
+          description: URL of image to display as a banner for the powerpack.
+          type: string
+        powerpack_id:
+          description: UUID of the associated powerpack.
+          example: df43cf2a-6475-490d-b686-6fbc6cb9a49c
+          type: string
+        show_title:
+          default: true
+          description: Whether to show the title or not.
+          type: boolean
+        template_variables:
+          $ref: '#/components/schemas/PowerpackTemplateVariables'
+        title:
+          description: Title of the widget.
+          type: string
+        type:
+          $ref: '#/components/schemas/PowerpackWidgetDefinitionType'
+      required:
+      - type
+      - powerpack_id
+      type: object
+    PowerpackWidgetDefinitionType:
+      default: powerpack
+      description: Type of the powerpack widget.
+      enum:
+      - powerpack
+      example: powerpack
+      type: string
+      x-enum-varnames:
+      - POWERPACK
     ProcessQueryDefinition:
       description: The process query to use in the widget.
       properties:
@@ -19975,6 +20055,7 @@ components:
       - $ref: '#/components/schemas/LogStreamWidgetDefinition'
       - $ref: '#/components/schemas/MonitorSummaryWidgetDefinition'
       - $ref: '#/components/schemas/NoteWidgetDefinition'
+      - $ref: '#/components/schemas/PowerpackWidgetDefinition'
       - $ref: '#/components/schemas/QueryValueWidgetDefinition'
       - $ref: '#/components/schemas/RunWorkflowWidgetDefinition'
       - $ref: '#/components/schemas/SLOListWidgetDefinition'

examples/v1/dashboards/CreateDashboard_1754992756.java

@@ -0,0 +1,69 @@
+// Create a new dashboard with powerpack widget
+
+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.PowerpackTemplateVariableContents;
+import com.datadog.api.client.v1.model.PowerpackTemplateVariables;
+import com.datadog.api.client.v1.model.PowerpackWidgetDefinition;
+import com.datadog.api.client.v1.model.PowerpackWidgetDefinitionType;
+import com.datadog.api.client.v1.model.Widget;
+import com.datadog.api.client.v1.model.WidgetDefinition;
+import com.datadog.api.client.v1.model.WidgetLayout;
+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 "powerpack" in the system
+    String POWERPACK_DATA_ID = System.getenv("POWERPACK_DATA_ID");
+
+    Dashboard body =
+        new Dashboard()
+            .title("Example-Dashboard with powerpack widget")
+            .layoutType(DashboardLayoutType.ORDERED)
+            .widgets(
+                Collections.singletonList(
+                    new Widget()
+                        .definition(
+                            new WidgetDefinition(
+                                new PowerpackWidgetDefinition()
+                                    .type(PowerpackWidgetDefinitionType.POWERPACK)
+                                    .powerpackId(POWERPACK_DATA_ID)
+                                    .templateVariables(
+                                        new PowerpackTemplateVariables()
+                                            .controlledByPowerpack(
+                                                Collections.singletonList(
+                                                    new PowerpackTemplateVariableContents()
+                                                        .name("foo")
+                                                        .prefix("bar")
+                                                        .values(
+                                                            Arrays.asList(
+                                                                "baz", "qux", "quuz")))))))
+                        .layout(
+                            new WidgetLayout()
+                                .x(1L)
+                                .y(1L)
+                                .width(2L)
+                                .height(2L)
+                                .isColumnBreak(false))))
+            .description("description")
+            .isReadOnly(false);
+
+    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();
+    }
+  }
+}

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

@@ -0,0 +1,210 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2019-Present Datadog, Inc.
+ */
+
+package com.datadog.api.client.v1.model;
+
+import com.fasterxml.jackson.annotation.JsonAnyGetter;
+import com.fasterxml.jackson.annotation.JsonAnySetter;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+
+/** Powerpack template variable contents. */
+@JsonPropertyOrder({
+  PowerpackTemplateVariableContents.JSON_PROPERTY_NAME,
+  PowerpackTemplateVariableContents.JSON_PROPERTY_PREFIX,
+  PowerpackTemplateVariableContents.JSON_PROPERTY_VALUES
+})
+@jakarta.annotation.Generated(
+    value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
+public class PowerpackTemplateVariableContents {
+  @JsonIgnore public boolean unparsed = false;
+  public static final String JSON_PROPERTY_NAME = "name";
+  private String name;
+
+  public static final String JSON_PROPERTY_PREFIX = "prefix";
+  private String prefix;
+
+  public static final String JSON_PROPERTY_VALUES = "values";
+  private List<String> values = new ArrayList<>();
+
+  public PowerpackTemplateVariableContents() {}
+
+  @JsonCreator
+  public PowerpackTemplateVariableContents(
+      @JsonProperty(required = true, value = JSON_PROPERTY_NAME) String name,
+      @JsonProperty(required = true, value = JSON_PROPERTY_VALUES) List<String> values) {
+    this.name = name;
+    this.values = values;
+  }
+
+  public PowerpackTemplateVariableContents name(String name) {
+    this.name = name;
+    return this;
+  }
+
+  /**
+   * The name of the variable.
+   *
+   * @return name
+   */
+  @JsonProperty(JSON_PROPERTY_NAME)
+  @JsonInclude(value = JsonInclude.Include.ALWAYS)
+  public String getName() {
+    return name;
+  }
+
+  public void setName(String name) {
+    this.name = name;
+  }
+
+  public PowerpackTemplateVariableContents prefix(String prefix) {
+    this.prefix = prefix;
+    return this;
+  }
+
+  /**
+   * The tag prefix associated with the variable.
+   *
+   * @return prefix
+   */
+  @jakarta.annotation.Nullable
+  @JsonProperty(JSON_PROPERTY_PREFIX)
+  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  public String getPrefix() {
+    return prefix;
+  }
+
+  public void setPrefix(String prefix) {
+    this.prefix = prefix;
+  }
+
+  public PowerpackTemplateVariableContents values(List<String> values) {
+    this.values = values;
+    return this;
+  }
+
+  public PowerpackTemplateVariableContents addValuesItem(String valuesItem) {
+    this.values.add(valuesItem);
+    return this;
+  }
+
+  /**
+   * One or many template variable values within the saved view, which will be unioned together
+   * using <code>OR</code> if more than one is specified.
+   *
+   * @return values
+   */
+  @JsonProperty(JSON_PROPERTY_VALUES)
+  @JsonInclude(value = JsonInclude.Include.ALWAYS)
+  public List<String> getValues() {
+    return values;
+  }
+
+  public void setValues(List<String> values) {
+    this.values = values;
+  }
+
+  /**
+   * A container for additional, undeclared properties. This is a holder for any undeclared
+   * properties as specified with the 'additionalProperties' keyword in the OAS document.
+   */
+  private Map<String, Object> additionalProperties;
+
+  /**
+   * Set the additional (undeclared) property with the specified name and value. If the property
+   * does not already exist, create it otherwise replace it.
+   *
+   * @param key The arbitrary key to set
+   * @param value The associated value
+   * @return PowerpackTemplateVariableContents
+   */
+  @JsonAnySetter
+  public PowerpackTemplateVariableContents putAdditionalProperty(String key, Object value) {
+    if (this.additionalProperties == null) {
+      this.additionalProperties = new HashMap<String, Object>();
+    }
+    this.additionalProperties.put(key, value);
+    return this;
+  }
+
+  /**
+   * Return the additional (undeclared) property.
+   *
+   * @return The additional properties
+   */
+  @JsonAnyGetter
+  public Map<String, Object> getAdditionalProperties() {
+    return additionalProperties;
+  }
+
+  /**
+   * Return the additional (undeclared) property with the specified name.
+   *
+   * @param key The arbitrary key to get
+   * @return The specific additional property for the given key
+   */
+  public Object getAdditionalProperty(String key) {
+    if (this.additionalProperties == null) {
+      return null;
+    }
+    return this.additionalProperties.get(key);
+  }
+
+  /** Return true if this PowerpackTemplateVariableContents object is equal to o. */
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) {
+      return true;
+    }
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+    PowerpackTemplateVariableContents powerpackTemplateVariableContents =
+        (PowerpackTemplateVariableContents) o;
+    return Objects.equals(this.name, powerpackTemplateVariableContents.name)
+        && Objects.equals(this.prefix, powerpackTemplateVariableContents.prefix)
+        && Objects.equals(this.values, powerpackTemplateVariableContents.values)
+        && Objects.equals(
+            this.additionalProperties, powerpackTemplateVariableContents.additionalProperties);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(name, prefix, values, additionalProperties);
+  }
+
+  @Override
+  public String toString() {
+    StringBuilder sb = new StringBuilder();
+    sb.append("class PowerpackTemplateVariableContents {\n");
+    sb.append("    name: ").append(toIndentedString(name)).append("\n");
+    sb.append("    prefix: ").append(toIndentedString(prefix)).append("\n");
+    sb.append("    values: ").append(toIndentedString(values)).append("\n");
+    sb.append("    additionalProperties: ")
+        .append(toIndentedString(additionalProperties))
+        .append("\n");
+    sb.append("}");
+    return sb.toString();
+  }
+
+  /**
+   * Convert the given object to string with each line indented by 4 spaces (except the first line).
+   */
+  private String toIndentedString(Object o) {
+    if (o == null) {
+      return "null";
+    }
+    return o.toString().replace("\n", "\n    ");
+  }
+}