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.

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

Spans API docs update #1442

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.5",
"regenerated": "2023-07-03 06:07:24.406048",
"spec_repo_commit": "832b2752"
"regenerated": "2023-07-03 09:29:30.628615",
"spec_repo_commit": "29891cab"
},
"v2": {
"apigentools_version": "1.6.5",
"regenerated": "2023-07-03 06:07:24.418998",
"spec_repo_commit": "832b2752"
"regenerated": "2023-07-03 09:29:30.643551",
"spec_repo_commit": "29891cab"
}
}
}
18 changes: 15 additions & 3 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24437,8 +24437,10 @@ paths:
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/spans/analytics/aggregate:
post:
description: The API endpoint to aggregate spans into buckets and compute metrics
description: 'The API endpoint to aggregate spans into buckets and compute metrics
and timeseries.

This endpoint is rate limited to `300` requests per hour.'
operationId: AggregateSpans
requestBody:
content:
Expand Down Expand Up @@ -24470,7 +24472,12 @@ paths:
[Results are paginated][1].


Use this endpoint to see your latest spans.'
Use this endpoint to see your latest spans.

This endpoint is rate limited to `300` requests per hour.


[1]: /logs/guide/collect-multiple-logs-with-pagination'
operationId: ListSpansGet
parameters:
- description: Search query following spans syntax.
Expand Down Expand Up @@ -24550,7 +24557,12 @@ paths:
[Results are paginated][1].


Use this endpoint to build complex spans filtering and search.'
Use this endpoint to build complex spans filtering and search.

This endpoint is rate limited to `300` requests per hour.


[1]: /logs/guide/collect-multiple-logs-with-pagination'
operationId: ListSpans
requestBody:
content:
Expand Down
7 changes: 7 additions & 0 deletions lib/datadog_api_client/v2/api/spans_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ def aggregate_spans(body, opts = {})
# Aggregate spans.
#
# The API endpoint to aggregate spans into buckets and compute metrics and timeseries.
# This endpoint is rate limited to `300` requests per hour.
#
# @param body [SpansAggregateRequest]
# @param opts [Hash] the optional parameters
Expand Down Expand Up @@ -104,6 +105,9 @@ def list_spans(body, opts = {})
# [Results are paginated][1].
#
# Use this endpoint to build complex spans filtering and search.
# This endpoint is rate limited to `300` requests per hour.
#
# [1]: /logs/guide/collect-multiple-logs-with-pagination
#
# @param body [SpansListRequest]
# @param opts [Hash] the optional parameters
Expand Down Expand Up @@ -195,6 +199,9 @@ def list_spans_get(opts = {})
# [Results are paginated][1].
#
# Use this endpoint to see your latest spans.
# This endpoint is rate limited to `300` requests per hour.
#
# [1]: /logs/guide/collect-multiple-logs-with-pagination
#
# @param opts [Hash] the optional parameters
# @option opts [String] :filter_query Search query following spans syntax.
Expand Down