Skip to content

Add data projection support to scatterplot widget OpenAPI spec #3729

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add data projection support to scatterplot widget OpenAPI spec #3729

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 109 additions & 1 deletion .generator/schemas/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13325,6 +13325,88 @@ components:
type: string
x-enum-varnames:
- SCATTERPLOT
ScatterplotDataProjectionDimension:
description: A single dimension mapping for a scatterplot data projection.
properties:
alias:
description: Display alias for the dimension.
type: string
column:
description: The column name from the data source.
example: duration
type: string
dimension:
$ref: "#/components/schemas/ScatterplotDimension"
number_format:
$ref: "#/components/schemas/WidgetNumberFormat"
required:
- column
- dimension
type: object
ScatterplotDataProjectionProjection:
description: The projection configuration for a scatterplot data projection request.
properties:
dimensions:
description: Dimension mappings for the scatterplot axes.
items:
$ref: "#/components/schemas/ScatterplotDataProjectionDimension"
type: array
type:
$ref: "#/components/schemas/ScatterplotDataProjectionProjectionType"
required:
- type
- dimensions
type: object
ScatterplotDataProjectionProjectionType:
description: The type of the scatterplot data projection.
enum:
- scatterplot
example: scatterplot
type: string
x-enum-varnames:
- SCATTERPLOT
ScatterplotDataProjectionQuery:
description: The query for a scatterplot data projection request.
properties:
data_source:
$ref: "#/components/schemas/FormulaAndFunctionEventsDataSource"
indexes:
description: Indexes to search.
items:
type: string
type: array
query_string:
description: The search query string.
example: "@service:web-store"
type: string
storage:
$ref: "#/components/schemas/ScatterplotDataProjectionQueryStorage"
required:
- query_string
- data_source
type: object
ScatterplotDataProjectionQueryStorage:
description: Storage tier to query.
enum:
- live
- hot
- habanero
- online_archives
- driveline
- flex_tier
- case_insensitive
- cloud_prem
example: hot
type: string
x-enum-varnames:
- LIVE
- HOT
- HABANERO
- ONLINE_ARCHIVES
- DRIVELINE
- FLEX_TIER
- CASE_INSENSITIVE
- CLOUD_PREM
ScatterplotDimension:
description: Dimension of the Scatterplot.
enum:
Expand All @@ -13340,21 +13422,47 @@ components:
- RADIUS
- COLOR
ScatterplotTableRequest:
description: Scatterplot request containing formulas and functions.
description: |-
Scatterplot table request. Supports two modes:
- **Formulas and functions** (default): `request_type` is absent or `"table"`. Uses `queries` and `formulas`.
- **Data projection**: `request_type` is `"data_projection"`. Uses `query`, `projection`, and optionally `limit`.
properties:
formulas:
description: List of Scatterplot formulas that operate on queries.
items:
$ref: "#/components/schemas/ScatterplotWidgetFormula"
type: array
limit:
description: Maximum number of rows to return. Used when `request_type` is `"data_projection"`.
format: int64
type: integer
projection:
$ref: "#/components/schemas/ScatterplotDataProjectionProjection"
description: Projection configuration for data projection mode. Used when `request_type` is `"data_projection"`.
queries:
description: List of queries that can be returned directly or used in formulas.
items:
$ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
type: array
query:
$ref: "#/components/schemas/ScatterplotDataProjectionQuery"
description: Query for data projection mode. Used when `request_type` is `"data_projection"`.
request_type:
$ref: "#/components/schemas/ScatterplotTableRequestType"
description: The type of the scatterplot table request. Use `"data_projection"` for unaggregated raw data.
response_format:
$ref: "#/components/schemas/FormulaAndFunctionResponseFormat"
type: object
ScatterplotTableRequestType:
description: The type of the scatterplot table request.
enum:
- table
- data_projection
example: data_projection
type: string
x-enum-varnames:
- TABLE
- DATA_PROJECTION
ScatterplotWidgetAggregator:
description: Aggregator used for the request.
enum:
Expand Down
59 changes: 57 additions & 2 deletions examples/v1/dashboards/CreateDashboard_2342457693.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
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.FormulaAndFunctionEventsDataSource;
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricAggregation;
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricDataSource;
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricQueryDefinition;
Expand All @@ -13,8 +14,13 @@
import com.datadog.api.client.v1.model.ScatterPlotWidgetDefinition;
import com.datadog.api.client.v1.model.ScatterPlotWidgetDefinitionRequests;
import com.datadog.api.client.v1.model.ScatterPlotWidgetDefinitionType;
import com.datadog.api.client.v1.model.ScatterplotDataProjectionDimension;
import com.datadog.api.client.v1.model.ScatterplotDataProjectionProjection;
import com.datadog.api.client.v1.model.ScatterplotDataProjectionProjectionType;
import com.datadog.api.client.v1.model.ScatterplotDataProjectionQuery;
import com.datadog.api.client.v1.model.ScatterplotDimension;
import com.datadog.api.client.v1.model.ScatterplotTableRequest;
import com.datadog.api.client.v1.model.ScatterplotTableRequestType;
import com.datadog.api.client.v1.model.ScatterplotWidgetFormula;
import com.datadog.api.client.v1.model.Widget;
import com.datadog.api.client.v1.model.WidgetAxis;
Expand All @@ -24,7 +30,6 @@
import com.datadog.api.client.v1.model.WidgetTextAlign;
import com.datadog.api.client.v1.model.WidgetTime;
import java.util.Arrays;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
Expand All @@ -36,7 +41,7 @@ public static void main(String[] args) {
.title("Example-Dashboard")
.description("")
.widgets(
Collections.singletonList(
Arrays.asList(
new Widget()
.layout(new WidgetLayout().x(0L).y(0L).width(47L).height(15L))
.definition(
Expand Down Expand Up @@ -95,6 +100,56 @@ public static void main(String[] args) {
.includeZero(true)
.min("auto")
.max("auto"))
.yaxis(
new WidgetAxis()
.scale("linear")
.includeZero(true)
.min("auto")
.max("auto")))),
new Widget()
.layout(new WidgetLayout().x(48L).y(0L).width(47L).height(15L))
.definition(
new WidgetDefinition(
new ScatterPlotWidgetDefinition()
.title("Data Projection Scatterplot")
.titleSize("16")
.titleAlign(WidgetTextAlign.LEFT)
.type(ScatterPlotWidgetDefinitionType.SCATTERPLOT)
.requests(
new ScatterPlotWidgetDefinitionRequests()
.table(
new ScatterplotTableRequest()
.requestType(
ScatterplotTableRequestType.DATA_PROJECTION)
.query(
new ScatterplotDataProjectionQuery()
.queryString("@service:web-store")
.dataSource(
FormulaAndFunctionEventsDataSource
.SPANS))
.projection(
new ScatterplotDataProjectionProjection()
.type(
ScatterplotDataProjectionProjectionType
.SCATTERPLOT)
.dimensions(
Arrays.asList(
new ScatterplotDataProjectionDimension()
.column("duration")
.dimension(
ScatterplotDimension.X),
new ScatterplotDataProjectionDimension()
.column("@resource_name")
.dimension(
ScatterplotDimension
.Y))))
.limit(200L)))
.xaxis(
new WidgetAxis()
.scale("linear")
.includeZero(true)
.min("auto")
.max("auto"))
.yaxis(
new WidgetAxis()
.scale("linear")
Expand Down
6 changes: 5 additions & 1 deletion src/main/java/com/datadog/api/client/v1/model/ScatterPlotWidgetDefinitionRequests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,11 @@ public ScatterPlotWidgetDefinitionRequests table(ScatterplotTableRequest table)
}

/**
* Scatterplot request containing formulas and functions.
* Scatterplot table request. Supports two modes: - <strong>Formulas and functions</strong>
* (default): <code>request_type</code> is absent or <code>"table"</code>. Uses <code>queries
* </code> and <code>formulas</code>. - <strong>Data projection</strong>: <code>request_type
* </code> is <code>"data_projection"</code>. Uses <code>query</code>, <code>projection</code>,
* and optionally <code>limit</code>.
*
* @return table
*/
Expand Down
Loading
Loading