Skip to content
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

Add tileDef sort attribute #23198

Merged
merged 2 commits into from
May 23, 2024
Merged

Add tileDef sort attribute #23198

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1111b2f
Regenerate client from commit 95a954a4 of spec repo
May 23, 2024
cf1d5b0
Merge branch 'master' into datadog-api-spec/generated/2785
api-clients-generation-pipeline[bot] May 23, 2024
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
Next Next commit
Regenerate client from commit 95a954a4 of spec repo
  • Loading branch information
ci.datadog-api-spec committed May 23, 2024
commit 1111b2fe4caabf6ecae3f64e028d641312b3f11b
8 changes: 4 additions & 4 deletions .apigentools-info
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2024-05-23 11:01:20.305476",
"spec_repo_commit": "b829bfa2"
"regenerated": "2024-05-23 18:16:17.266867",
"spec_repo_commit": "95a954a4"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-05-23 11:01:28.198221",
"spec_repo_commit": "b829bfa2"
"regenerated": "2024-05-23 18:16:25.107173",
"spec_repo_commit": "95a954a4"
}
}
}
16 changes: 11 additions & 5 deletions content/en/api/v1/dashboards/request.CreateDashboard_1213075383.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,19 @@
],
"formulas": [
{
"formula": "query1",
"limit": {
"count": 10,
"order": "desc"
}
"formula": "query1"
}
],
"sort": {
"count": 10,
"order_by": [
{
"type": "formula",
"index": 0,
"order": "desc"
}
]
},
"response_format": "scalar"
}
]
Expand Down
14 changes: 10 additions & 4 deletions content/en/api/v1/dashboards/request.CreateDashboard_2336428357.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,20 @@
"formulas": [
{
"formula": "query1",
"limit": {
"count": 500,
"order": "desc"
},
"conditional_formats": [],
"cell_display_mode": "bar"
}
],
"sort": {
"count": 500,
"order_by": [
{
"type": "formula",
"index": 0,
"order": "desc"
}
]
},
"response_format": "scalar"
}
],
Expand Down
60 changes: 60 additions & 0 deletions content/en/api/v1/dashboards/request.CreateDashboard_2563642929.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
{
"title": "Example-Dashboard",
"description": "",
"widgets": [
{
"layout": {
"x": 0,
"y": 0,
"width": 47,
"height": 15
},
"definition": {
"title": "",
"title_size": "16",
"title_align": "left",
"time": {},
"style": {
"display": {
"type": "stacked",
"legend": "inline"
},
"scaling": "relative"
},
"type": "toplist",
"requests": [
{
"queries": [
{
"data_source": "metrics",
"name": "query1",
"query": "avg:system.cpu.user{*} by {service}",
"aggregator": "avg"
}
],
"formulas": [
{
"formula": "query1"
}
],
"sort": {
"count": 10,
"order_by": [
{
"type": "group",
"name": "service",
"order": "asc"
}
]
},
"response_format": "scalar"
}
]
}
}
],
"template_variables": [],
"layout_type": "free",
"is_read_only": false,
"notify_list": []
}
16 changes: 11 additions & 5 deletions content/en/api/v1/dashboards/request.CreateDashboard_3669695268.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,19 @@
{
"conditional_formats": [],
"cell_display_mode": "bar",
"formula": "query1",
"limit": {
"count": 50,
"order": "desc"
}
"formula": "query1"
}
],
"sort": {
"count": 50,
"order_by": [
{
"type": "formula",
"index": 0,
"order": "desc"
}
]
},
"response_format": "scalar"
}
]
Expand Down
16 changes: 11 additions & 5 deletions content/en/api/v1/dashboards/request.CreateDashboard_915214113.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,7 @@
{
"formulas": [
{
"formula": "query1",
"limit": {
"count": 250,
"order": "desc"
}
"formula": "query1"
}
],
"queries": [
Expand Down Expand Up @@ -51,6 +47,16 @@
]
}
],
"sort": {
"count": 250,
"order_by": [
{
"type": "formula",
"index": 0,
"order": "desc"
}
]
},
"response_format": "scalar"
}
],
Expand Down
38 changes: 34 additions & 4 deletions content/en/api/v1/dashboards/widgets.json
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions content/en/api/v1/notebooks/examples.json
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions data/api/v1/CodeExamples.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,11 @@
"suffix": "_1284514532",
"description": "Create a new dashboard with a timeseries widget using formulas and functions cloud cost query"
},
{
"group": "dashboards",
"suffix": "_2563642929",
"description": "Create a new dashboard with a toplist widget sorted by group"
},
{
"group": "dashboards",
"suffix": "_2308247857",
Expand Down
75 changes: 75 additions & 0 deletions data/api/v1/full_spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3142,6 +3142,14 @@ components:
type: string
x-enum-varnames:
- METRIC
FormulaType:
description: Set the sort type to formula.
enum:
- formula
example: formula
type: string
x-enum-varnames:
- FORMULA
FreeTextWidgetDefinition:
description: Free text is a widget that allows you to add headings to your screenboard.
Commonly used to state the overall purpose of the dashboard. Only available
Expand Down Expand Up @@ -3510,6 +3518,8 @@ components:
$ref: '#/components/schemas/LogQueryDefinition'
security_query:
$ref: '#/components/schemas/LogQueryDefinition'
sort:
$ref: '#/components/schemas/WidgetSortBy'
type: object
GraphSnapshot:
description: Object representing a graph snapshot.
Expand All @@ -3530,6 +3540,14 @@ components:
example: https://app.datadoghq.com/s/f12345678/aaa-bbb-ccc
type: string
type: object
GroupType:
description: Set the sort type to group.
enum:
- group
example: group
type: string
x-enum-varnames:
- GROUP
GroupWidgetDefinition:
description: The groups widget allows you to keep similar graphs together on
your timeboard. Each group has a custom header, can hold one to many graphs,
Expand Down Expand Up @@ -16621,6 +16639,8 @@ components:
$ref: '#/components/schemas/LogQueryDefinition'
security_query:
$ref: '#/components/schemas/LogQueryDefinition'
sort:
$ref: '#/components/schemas/WidgetSortBy'
type: object
TagToHosts:
description: In this object, the key is the tag, the value is a list of host
Expand Down Expand Up @@ -16957,6 +16977,8 @@ components:
$ref: '#/components/schemas/LogQueryDefinition'
security_query:
$ref: '#/components/schemas/LogQueryDefinition'
sort:
$ref: '#/components/schemas/WidgetSortBy'
style:
$ref: '#/components/schemas/WidgetRequestStyle'
type: object
Expand Down Expand Up @@ -21168,6 +21190,24 @@ components:
order:
$ref: '#/components/schemas/QuerySortOrder'
type: object
WidgetFormulaSort:
description: The formula to sort the widget by.
properties:
index:
description: The index of the formula to sort by.
example: 0
format: int64
minimum: 0
type: integer
order:
$ref: '#/components/schemas/WidgetSort'
type:
$ref: '#/components/schemas/FormulaType'
required:
- type
- index
- order
type: object
WidgetFormulaStyle:
description: Styling options for widget formulas.
properties:
Expand All @@ -21182,6 +21222,22 @@ components:
format: int64
type: integer
type: object
WidgetGroupSort:
description: The group to sort the widget by.
properties:
name:
description: The name of the group.
example: group_name
type: string
order:
$ref: '#/components/schemas/WidgetSort'
type:
$ref: '#/components/schemas/GroupType'
required:
- type
- name
- order
type: object
WidgetGrouping:
description: The kind of grouping to use.
enum:
Expand Down Expand Up @@ -21557,6 +21613,25 @@ components:
x-enum-varnames:
- ASCENDING
- DESCENDING
WidgetSortBy:
description: The controls for sorting the widget.
properties:
count:
description: The number of items to limit the widget to.
format: int64
minimum: 0
type: integer
order_by:
description: The array of items to sort the widget by in order.
items:
$ref: '#/components/schemas/WidgetSortOrderBy'
type: array
type: object
WidgetSortOrderBy:
description: The item to sort the widget by.
oneOf:
- $ref: '#/components/schemas/WidgetFormulaSort'
- $ref: '#/components/schemas/WidgetGroupSort'
WidgetStyle:
description: Widget style definition.
properties:
Expand Down
Loading