Skip to content

Commit 54969b3

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Spans API docs update (#1553)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 9b9df84 commit 54969b3

File tree

3 files changed

+24
-9
lines changed

3 files changed

+24
-9
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.5",
7-
"regenerated": "2023-07-03 06:07:19.450806",
8-
"spec_repo_commit": "832b2752"
7+
"regenerated": "2023-07-03 09:29:29.728054",
8+
"spec_repo_commit": "29891cab"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.5",
12-
"regenerated": "2023-07-03 06:07:19.468637",
13-
"spec_repo_commit": "832b2752"
12+
"regenerated": "2023-07-03 09:29:29.740678",
13+
"spec_repo_commit": "29891cab"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24437,8 +24437,10 @@ paths:
2443724437
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
2443824438
/api/v2/spans/analytics/aggregate:
2443924439
post:
24440-
description: The API endpoint to aggregate spans into buckets and compute metrics
24440+
description: 'The API endpoint to aggregate spans into buckets and compute metrics
2444124441
and timeseries.
24442+
24443+
This endpoint is rate limited to `300` requests per hour.'
2444224444
operationId: AggregateSpans
2444324445
requestBody:
2444424446
content:
@@ -24470,7 +24472,12 @@ paths:
2447024472
[Results are paginated][1].
2447124473

2447224474

24473-
Use this endpoint to see your latest spans.'
24475+
Use this endpoint to see your latest spans.
24476+
24477+
This endpoint is rate limited to `300` requests per hour.
24478+
24479+
24480+
[1]: /logs/guide/collect-multiple-logs-with-pagination'
2447424481
operationId: ListSpansGet
2447524482
parameters:
2447624483
- description: Search query following spans syntax.
@@ -24550,7 +24557,12 @@ paths:
2455024557
[Results are paginated][1].
2455124558

2455224559

24553-
Use this endpoint to build complex spans filtering and search.'
24560+
Use this endpoint to build complex spans filtering and search.
24561+
24562+
This endpoint is rate limited to `300` requests per hour.
24563+
24564+
24565+
[1]: /logs/guide/collect-multiple-logs-with-pagination'
2455424566
operationId: ListSpans
2455524567
requestBody:
2455624568
content:

src/datadog_api_client/v2/api/spans_api.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@ def aggregate_spans(
129129
"""Aggregate spans.
130130
131131
The API endpoint to aggregate spans into buckets and compute metrics and timeseries.
132+
This endpoint is rate limited to ``300`` requests per hour.
132133
133134
:type body: SpansAggregateRequest
134135
:rtype: SpansAggregateResponse
@@ -145,9 +146,10 @@ def list_spans(
145146
"""Search spans.
146147
147148
List endpoint returns spans that match a span search query.
148-
[Results are paginated][1].
149+
`Results are paginated </logs/guide/collect-multiple-logs-with-pagination>`_.
149150
150151
Use this endpoint to build complex spans filtering and search.
152+
This endpoint is rate limited to ``300`` requests per hour.
151153
152154
:type body: SpansListRequest
153155
:rtype: SpansListResponse
@@ -202,9 +204,10 @@ def list_spans_get(
202204
"""Get a list of spans.
203205
204206
List endpoint returns spans that match a span search query.
205-
[Results are paginated][1].
207+
`Results are paginated </logs/guide/collect-multiple-logs-with-pagination>`_.
206208
207209
Use this endpoint to see your latest spans.
210+
This endpoint is rate limited to ``300`` requests per hour.
208211
209212
:param filter_query: Search query following spans syntax.
210213
:type filter_query: str, optional

0 commit comments

Comments
 (0)