Skip to content

Commit 68b1d52

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 849304a of spec repo
1 parent 391c643 commit 68b1d52

File tree

12 files changed

+341
-16
lines changed

12 files changed

+341
-16
lines changed

config/_default/menus/api.en.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5100,6 +5100,22 @@ menu:
51005100
unstable:
51015101
- v2
51025102
order: 4
5103+
- name: APM
5104+
url: /api/latest/apm/
5105+
identifier: apm
5106+
generated: true
5107+
- name: Get service list
5108+
url: '#get-service-list'
5109+
identifier: apm-get-service-list
5110+
parent: apm
5111+
generated: true
5112+
params:
5113+
versions:
5114+
- v2
5115+
operationids:
5116+
- GetServiceList
5117+
unstable: []
5118+
order: 1
51035119
- name: APM Retention Filters
51045120
url: /api/latest/apm-retention-filters/
51055121
identifier: apm-retention-filters
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: APM
3+
---

content/en/api/v1/dashboards/examples.json

Lines changed: 5 additions & 5 deletions
Large diffs are not rendered by default.
Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
{
2+
"title": "Example-Dashboard",
3+
"description": "Example-Dashboard",
4+
"widgets": [
5+
{
6+
"definition": {
7+
"title": "Log Count by Service and Source",
8+
"type": "geomap",
9+
"requests": [
10+
{
11+
"response_format": "scalar",
12+
"queries": [
13+
{
14+
"data_source": "rum",
15+
"name": "query1",
16+
"search": {
17+
"query": "@type:session"
18+
},
19+
"indexes": [
20+
"*"
21+
],
22+
"compute": {
23+
"aggregation": "count"
24+
},
25+
"group_by": []
26+
}
27+
],
28+
"conditional_formats": [
29+
{
30+
"comparator": ">",
31+
"value": 1000,
32+
"palette": "white_on_green"
33+
}
34+
],
35+
"formulas": [
36+
{
37+
"formula": "query1"
38+
}
39+
],
40+
"sort": {
41+
"count": 250,
42+
"order_by": [
43+
{
44+
"type": "formula",
45+
"index": 0,
46+
"order": "desc"
47+
}
48+
]
49+
}
50+
},
51+
{
52+
"response_format": "event_list",
53+
"query": {
54+
"data_source": "logs_stream",
55+
"query_string": "",
56+
"indexes": [],
57+
"storage": "hot"
58+
},
59+
"columns": [
60+
{
61+
"field": "@network.client.geoip.location.latitude",
62+
"width": "auto"
63+
},
64+
{
65+
"field": "@network.client.geoip.location.longitude",
66+
"width": "auto"
67+
},
68+
{
69+
"field": "@network.client.geoip.country.iso_code",
70+
"width": "auto"
71+
},
72+
{
73+
"field": "@network.client.geoip.subdivision.name",
74+
"width": "auto"
75+
}
76+
],
77+
"style": {
78+
"color_by": "status"
79+
},
80+
"text_formats": [
81+
{
82+
"match": {
83+
"type": "is",
84+
"value": "error"
85+
},
86+
"palette": "white_on_red"
87+
}
88+
]
89+
}
90+
],
91+
"style": {
92+
"palette": "hostmap_blues",
93+
"palette_flip": false
94+
},
95+
"view": {
96+
"focus": "NORTH_AMERICA"
97+
}
98+
},
99+
"layout": {
100+
"x": 0,
101+
"y": 0,
102+
"width": 12,
103+
"height": 6
104+
}
105+
}
106+
],
107+
"template_variables": [],
108+
"layout_type": "ordered",
109+
"notify_list": [],
110+
"reflow_type": "fixed",
111+
"tags": []
112+
}

content/en/api/v1/dashboards/widgets.json

Lines changed: 54 additions & 5 deletions
Large diffs are not rendered by default.

content/en/api/v2/apm/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: APM
3+
headless: true
4+
---
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
"GetServiceList": {
3+
"responses": {
4+
"200": {
5+
"json": {
6+
"data": {
7+
"attributes": {
8+
"metadata": [
9+
{
10+
"isTraced": false,
11+
"isUsm": false
12+
}
13+
],
14+
"services": []
15+
},
16+
"id": "string",
17+
"type": "services_list"
18+
}
19+
},
20+
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> data</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> attributes</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> metadata</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">isTraced</p>\n </div>\n <div class=\"col-2 column\"><p>boolean</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">isUsm</p>\n </div>\n <div class=\"col-2 column\"><p>boolean</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">services</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>Services list resource type. \nAllowed enum values: <code>services_list</code></p><p>default: <code>services_list</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
21+
},
22+
"429": {
23+
"json": {
24+
"errors": [
25+
"Bad Request"
26+
]
27+
},
28+
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>"
29+
}
30+
},
31+
"request": {
32+
"json_curl": {},
33+
"json": {},
34+
"html": ""
35+
}
36+
}
37+
}

data/api/v1/CodeExamples.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,11 @@
8181
"suffix": "_3513586382",
8282
"description": "Create a geomap widget using an event_list request"
8383
},
84+
{
85+
"group": "dashboards",
86+
"suffix": "_9836563",
87+
"description": "Create a geomap widget with conditional formats and text formats"
88+
},
8489
{
8590
"group": "dashboards",
8691
"suffix": "",

data/api/v1/full_spec.yaml

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3555,9 +3555,10 @@ components:
35553555
$ref: '#/components/schemas/WidgetCustomLink'
35563556
type: array
35573557
requests:
3558-
description: 'Array of one request object to display in the widget. The
3559-
request must contain a `group-by` tag whose value is a country ISO code.
3560-
3558+
description: 'Array of request objects to display in the widget. May include
3559+
an optional request for the region layer and/or an optional request for
3560+
the points layer. Region layer requests must contain a `group-by` tag
3561+
whose value is a country ISO code.
35613562

35623563
See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json)
35633564

@@ -3568,7 +3569,7 @@ components:
35683569
query: <METRIC_1>{<SCOPE_1>}
35693570
items:
35703571
$ref: '#/components/schemas/GeomapWidgetRequest'
3571-
maxItems: 1
3572+
maxItems: 2
35723573
minItems: 1
35733574
type: array
35743575
style:
@@ -3626,8 +3627,9 @@ components:
36263627
focus: WORLD
36273628
properties:
36283629
focus:
3629-
description: The 2-letter ISO code of a country to focus the map on. Or
3630-
`WORLD`.
3630+
description: The 2-letter ISO code of a country to focus the map on, or
3631+
`WORLD` for global view, or a region (`EMEA`, `APAC`, `LATAM`), or a continent
3632+
(`NORTH_AMERICA`, `SOUTH_AMERICA`, `EUROPE`, `AFRICA`, `ASIA`, `OCEANIA`).
36313633
example: WORLD
36323634
type: string
36333635
required:
@@ -3646,6 +3648,12 @@ components:
36463648
items:
36473649
$ref: '#/components/schemas/ListStreamColumn'
36483650
type: array
3651+
conditional_formats:
3652+
description: Threshold (numeric) conditional formatting rules may be used
3653+
by a regions layer.
3654+
items:
3655+
$ref: '#/components/schemas/WidgetConditionalFormat'
3656+
type: array
36493657
formulas:
36503658
description: List of formulas that operate on queries.
36513659
items:
@@ -3671,6 +3679,23 @@ components:
36713679
$ref: '#/components/schemas/LogQueryDefinition'
36723680
sort:
36733681
$ref: '#/components/schemas/WidgetSortBy'
3682+
style:
3683+
$ref: '#/components/schemas/GeomapWidgetRequestStyle'
3684+
text_formats:
3685+
description: Text formatting rules may be used by a points layer.
3686+
items:
3687+
$ref: '#/components/schemas/TableWidgetTextFormatRule'
3688+
type: array
3689+
type: object
3690+
GeomapWidgetRequestStyle:
3691+
description: The style to apply to the request for points layer.
3692+
example:
3693+
color_by: status
3694+
properties:
3695+
color_by:
3696+
description: The category to color the points by.
3697+
example: status
3698+
type: string
36743699
type: object
36753700
GraphSnapshot:
36763701
description: Object representing a graph snapshot.

data/api/v2/full_spec.yaml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51296,6 +51296,49 @@ components:
5129651296
$ref: '#/components/schemas/ServiceDefinitionData'
5129751297
type: array
5129851298
type: object
51299+
ServiceList:
51300+
properties:
51301+
data:
51302+
$ref: '#/components/schemas/ServiceListData'
51303+
type: object
51304+
ServiceListData:
51305+
properties:
51306+
attributes:
51307+
$ref: '#/components/schemas/ServiceListDataAttributes'
51308+
id:
51309+
type: string
51310+
type:
51311+
$ref: '#/components/schemas/ServiceListDataType'
51312+
required:
51313+
- type
51314+
type: object
51315+
ServiceListDataAttributes:
51316+
properties:
51317+
metadata:
51318+
items:
51319+
$ref: '#/components/schemas/ServiceListDataAttributesMetadataItems'
51320+
type: array
51321+
services:
51322+
items:
51323+
type: string
51324+
type: array
51325+
type: object
51326+
ServiceListDataAttributesMetadataItems:
51327+
properties:
51328+
isTraced:
51329+
type: boolean
51330+
isUsm:
51331+
type: boolean
51332+
type: object
51333+
ServiceListDataType:
51334+
default: services_list
51335+
description: Services list resource type.
51336+
enum:
51337+
- services_list
51338+
example: services_list
51339+
type: string
51340+
x-enum-varnames:
51341+
- SERVICES_LIST
5129951342
ServiceNowBasicAuth:
5130051343
description: The definition of the `ServiceNowBasicAuth` object.
5130151344
properties:
@@ -61560,6 +61603,27 @@ paths:
6156061603
permissions:
6156161604
- apm_retention_filter_write
6156261605
- apm_pipelines_write
61606+
/api/v2/apm/services:
61607+
get:
61608+
operationId: GetServiceList
61609+
responses:
61610+
'200':
61611+
content:
61612+
application/json:
61613+
schema:
61614+
$ref: '#/components/schemas/ServiceList'
61615+
description: OK
61616+
'429':
61617+
$ref: '#/components/responses/TooManyRequestsResponse'
61618+
security:
61619+
- apiKeyAuth: []
61620+
appKeyAuth: []
61621+
- AuthZ:
61622+
- apm_read
61623+
summary: Get service list
61624+
tags:
61625+
- APM
61626+
x-menu-order: 1
6156361627
/api/v2/app-builder/apps:
6156461628
delete:
6156561629
description: Delete multiple apps in a single request from a list of app IDs.
@@ -89319,6 +89383,9 @@ servers:
8931989383
tags:
8932089384
- description: Configure your API endpoints through the Datadog API.
8932189385
name: API Management
89386+
- description: Observe, troubleshoot, and improve cloud-scale applications with all
89387+
telemetry in context
89388+
name: APM
8932289389
- description: Manage configuration of [APM retention filters](https://app.datadoghq.com/apm/traces/retention-filters)
8932389390
for your organization. You need an API and application key with Admin rights to
8932489391
interact with this endpoint. See [retention filters](https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/#retention-filters)

0 commit comments

Comments
 (0)