Skip to content

add docs for pagination in /api/v2/metrics endpoint #2021

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

Merged
api-clients-generation-pipeline merged 1 commit into from
Dec 12, 2024
Merged

add docs for pagination in /api/v2/metrics endpoint #2021

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
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-12-11 20:35:37.297873",
"spec_repo_commit": "7b62d196"
"regenerated": "2024-12-12 13:29:22.131222",
"spec_repo_commit": "f0c3c0f4"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-12-11 20:35:37.316642",
"spec_repo_commit": "7b62d196"
"regenerated": "2024-12-12 13:29:22.150037",
"spec_repo_commit": "f0c3c0f4"
}
}
}
96 changes: 95 additions & 1 deletion .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16012,6 +16012,36 @@ components:
- COUNT
- RATE
- GAUGE
MetricMetaPage:
description: Paging attributes. Only present if pagination query parameters
were provided.
properties:
cursor:
description: The cursor used to get the current results, if any.
nullable: true
type: string
limit:
description: Number of results returned
format: int32
maximum: 20000
minimum: 0
type: integer
next_cursor:
description: The cursor used to get the next results, if any.
nullable: true
type: string
type:
$ref: '#/components/schemas/MetricMetaPageType'
type: object
MetricMetaPageType:
default: cursor_limit
description: Type of metric pagination.
enum:
- cursor_limit
example: cursor_limit
type: string
x-enum-varnames:
- CURSOR_LIMIT
MetricMetadata:
description: Metadata for the metric.
properties:
Expand Down Expand Up @@ -16094,6 +16124,12 @@ components:
maximum: 1000
type: integer
type: object
MetricPaginationMeta:
description: Response metadata object.
properties:
pagination:
$ref: '#/components/schemas/MetricMetaPage'
type: object
MetricPayload:
description: The metrics' payload.
properties:
Expand Down Expand Up @@ -16570,6 +16606,10 @@ components:
items:
$ref: '#/components/schemas/MetricsAndMetricTagConfigurations'
type: array
links:
$ref: '#/components/schemas/MetricsListResponseLinks'
meta:
$ref: '#/components/schemas/MetricPaginationMeta'
readOnly: true
type: object
MetricsDataSource:
Expand All @@ -16583,6 +16623,29 @@ components:
x-enum-varnames:
- METRICS
- CLOUD_COST
MetricsListResponseLinks:
description: Pagination links. Only present if pagination query parameters were
provided.
properties:
first:
description: Link to the first page.
type: string
last:
description: Link to the last page.
nullable: true
type: string
next:
description: Link to the next page.
nullable: true
type: string
prev:
description: Link to previous page.
nullable: true
type: string
self:
description: Link to current page.
type: string
type: object
MetricsScalarQuery:
description: An individual scalar metrics query.
properties:
Expand Down Expand Up @@ -35773,7 +35836,12 @@ paths:
get:
description: "Returns all metrics that can be configured in the Metrics Summary
page or with Metrics without Limits\u2122 (matching additional filters if
specified)."
specified).\nOptionally, paginate by using the `page[cursor]` and/or `page[size]`
query parameters.\nTo fetch the first page, pass in a query parameter with
either a valid `page[size]` or an empty cursor like `page[cursor]=`. To fetch
the next page, pass in the `next_cursor` value from the response as the new
`page[cursor]` value.\nOnce the `meta.pagination.next_cursor` value is null,
all pages have been retrieved."
operationId: ListTagConfigurations
parameters:
- description: Filter custom metrics that have configured tags.
Expand Down Expand Up @@ -35838,6 +35906,27 @@ paths:
schema:
format: int64
type: integer
- description: Maximum number of results returned.
in: query
name: page[size]
required: false
schema:
default: 10000
format: int32
maximum: 10000
minimum: 1
type: integer
- description: 'String to query the next page of results.

This key is provided with each valid response from the API in `meta.pagination.next_cursor`.

Once the `meta.pagination.next_cursor` key is null, all pages have been
retrieved.'
in: query
name: page[cursor]
required: false
schema:
type: string
responses:
'200':
content:
Expand Down Expand Up @@ -35871,6 +35960,11 @@ paths:
summary: Get a list of metrics
tags:
- Metrics
x-pagination:
cursorParam: page[cursor]
cursorPath: meta.pagination.next_cursor
limitParam: page[size]
resultsPath: data
x-permission:
operator: OR
permissions:
Expand Down
1 change: 1 addition & 0 deletions ...features/v2/metrics/Get-a-list-of-metrics-returns-Success-response-with-pagination.frozen
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2024-12-06T19:12:25.667Z
42 changes: 42 additions & 0 deletions ...es/features/v2/metrics/Get-a-list-of-metrics-returns-Success-response-with-pagination.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions examples/v2/metrics/ListTagConfigurations_3969783727.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Get a list of metrics returns "Success" response with pagination

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::MetricsAPI.new
opts = {
page_size: 2,
}
api_instance.list_tag_configurations_with_pagination(opts) { |item| puts item }
2 changes: 2 additions & 0 deletions features/scenarios_model_mapping.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1582,6 +1582,8 @@
"filter_queried" => "Boolean",
"filter_tags" => "String",
"window_seconds" => "Integer",
"page_size" => "Integer",
"page_cursor" => "String",
},
"v2.DeleteBulkTagsMetricsConfiguration" => {
"body" => "MetricBulkTagConfigDeleteRequest",
Expand Down
9 changes: 9 additions & 0 deletions features/v2/metrics.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,15 @@ Feature: Metrics
When the request is sent
Then the response status is 200 Success

@replay-only @skip-validation @team:DataDog/metrics-experience @with-pagination
Scenario: Get a list of metrics returns "Success" response with pagination
Given a valid "appKeyAuth" key in the system
And new "ListTagConfigurations" request
And request contains "page[size]" parameter with value 2
When the request with pagination is sent
Then the response status is 200 Success
And the response has 3 items

@team:DataDog/metrics-experience
Scenario: Get a list of metrics with a tag filter returns "Success" response
Given a valid "appKeyAuth" key in the system
Expand Down
4 changes: 4 additions & 0 deletions lib/datadog_api_client/inflector.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1868,11 +1868,14 @@ def overrides
"v2.metric_ingested_indexed_volume_type" => "MetricIngestedIndexedVolumeType",
"v2.metric_intake_type" => "MetricIntakeType",
"v2.metric_metadata" => "MetricMetadata",
"v2.metric_meta_page" => "MetricMetaPage",
"v2.metric_meta_page_type" => "MetricMetaPageType",
"v2.metric_monitor_asset" => "MetricMonitorAsset",
"v2.metric_monitor_type" => "MetricMonitorType",
"v2.metric_notebook_asset" => "MetricNotebookAsset",
"v2.metric_notebook_type" => "MetricNotebookType",
"v2.metric_origin" => "MetricOrigin",
"v2.metric_pagination_meta" => "MetricPaginationMeta",
"v2.metric_payload" => "MetricPayload",
"v2.metric_point" => "MetricPoint",
"v2.metric_resource" => "MetricResource",
Expand All @@ -1881,6 +1884,7 @@ def overrides
"v2.metrics_and_metric_tag_configurations_response" => "MetricsAndMetricTagConfigurationsResponse",
"v2.metrics_data_source" => "MetricsDataSource",
"v2.metric_series" => "MetricSeries",
"v2.metrics_list_response_links" => "MetricsListResponseLinks",
"v2.metric_slo_asset" => "MetricSLOAsset",
"v2.metric_slo_type" => "MetricSLOType",
"v2.metrics_scalar_query" => "MetricsScalarQuery",
Expand Down
34 changes: 34 additions & 0 deletions lib/datadog_api_client/v2/api/metrics_api.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -603,6 +603,9 @@ def list_tag_configurations(opts = {})
# Get a list of metrics.
#
# Returns all metrics that can be configured in the Metrics Summary page or with Metrics without Limits™ (matching additional filters if specified).
# Optionally, paginate by using the `page[cursor]` and/or `page[size]` query parameters.
# To fetch the first page, pass in a query parameter with either a valid `page[size]` or an empty cursor like `page[cursor]=`. To fetch the next page, pass in the `next_cursor` value from the response as the new `page[cursor]` value.
# Once the `meta.pagination.next_cursor` value is null, all pages have been retrieved.
#
# @param opts [Hash] the optional parameters
# @option opts [Boolean] :filter_configured Filter custom metrics that have configured tags.
Expand All @@ -612,6 +615,8 @@ def list_tag_configurations(opts = {})
# @option opts [Boolean] :filter_queried (Beta) Filter custom metrics that have or have not been queried in the specified window[seconds]. If no window is provided or the window is less than 2 hours, a default of 2 hours will be applied.
# @option opts [String] :filter_tags Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Can only be combined with the filter[queried] filter.
# @option opts [Integer] :window_seconds The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query. Default value is 3600 (1 hour), maximum value is 2,592,000 (30 days).
# @option opts [Integer] :page_size Maximum number of results returned.
# @option opts [String] :page_cursor String to query the next page of results. This key is provided with each valid response from the API in `meta.pagination.next_cursor`. Once the `meta.pagination.next_cursor` key is null, all pages have been retrieved.
# @return [Array<(MetricsAndMetricTagConfigurationsResponse, Integer, Hash)>] MetricsAndMetricTagConfigurationsResponse data, response status code and response headers
def list_tag_configurations_with_http_info(opts = {})

Expand All @@ -622,6 +627,12 @@ def list_tag_configurations_with_http_info(opts = {})
if @api_client.config.client_side_validation && opts[:'filter_metric_type'] && !allowable_values.include?(opts[:'filter_metric_type'])
fail ArgumentError, "invalid value for \"filter_metric_type\", must be one of #{allowable_values}"
end
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling MetricsAPI.list_tag_configurations, must be smaller than or equal to 10000.'
end
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling MetricsAPI.list_tag_configurations, must be greater than or equal to 1.'
end
# resource path
local_var_path = '/api/v2/metrics'

Expand All @@ -634,6 +645,8 @@ def list_tag_configurations_with_http_info(opts = {})
query_params[:'filter[queried]'] = opts[:'filter_queried'] if !opts[:'filter_queried'].nil?
query_params[:'filter[tags]'] = opts[:'filter_tags'] if !opts[:'filter_tags'].nil?
query_params[:'window[seconds]'] = opts[:'window_seconds'] if !opts[:'window_seconds'].nil?
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?

# header parameters
header_params = opts[:header_params] || {}
Expand Down Expand Up @@ -670,6 +683,27 @@ def list_tag_configurations_with_http_info(opts = {})
return data, status_code, headers
end

# Get a list of metrics.
#
# Provide a paginated version of {#list_tag_configurations}, returning all items.
#
# To use it you need to use a block: list_tag_configurations_with_pagination { |item| p item }
#
# @yield [MetricsAndMetricTagConfigurations] Paginated items
def list_tag_configurations_with_pagination(opts = {})
Copy link

@datadog-datadog-prod-us1 datadog-datadog-prod-us1 bot Sep 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚪ Code Quality Violation

Avoid using a hash as an optional parameter (...read more)

The rule "Avoid hash optional parameters" is a guideline that encourages developers to explicitly declare parameters instead of using a hash for optional parameters. This is because using a hash for optional parameters can make the code harder to understand and maintain. It can also lead to unexpected behavior if a developer accidentally includes a key in the hash that the method does not expect.

This rule is important because it promotes code readability and maintainability. It also helps prevent potential bugs that may occur due to unexpected keys in the optional hash. By explicitly declaring each parameter, developers can easily see what parameters a method expects, making the code easier to read and understand.

To adhere to this rule, instead of using a hash for optional parameters, explicitly declare each parameter in the method definition. For example, instead of using options = {} in the method definition, declare each parameter like name, email, age. This way, anyone reading the code can easily understand what parameters the method expects and in what order.

View in Datadog  Leave us feedback  Documentation

api_version = "V2"
page_size = @api_client.get_attribute_from_path(opts, "page_size", 10000)
@api_client.set_attribute_from_path(api_version, opts, "page_size", Integer, page_size)
while true do
Copy link

@datadog-datadog-prod-us1 datadog-datadog-prod-us1 bot Sep 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Code Quality Violation

Suggested change
while true do
loop do do
Don't use the expression `while true` for an infinite loop (...read more)

The Ruby static analysis rule "Use Kernel#loop instead of while/until" focuses on promoting the use of Kernel#loop for infinite loops rather than while true or until false. This is because Kernel#loop is more idiomatic to Ruby, and it communicates the intent of an infinite loop more clearly. This rule helps to maintain readability, which is crucial in large codebases where understanding the flow and function of the code is important.

The while true or until false expressions can be misleading as they suggest a condition that might change, even though they are used to create infinite loops. Using Kernel#loop eliminates this ambiguity, making the code easier to understand.

To adhere to this rule, replace any while true or until false loops with Kernel#loop. The body of the loop remains the same. This small change can significantly improve the clarity of the code, making it more understandable for other developers who might work on the same codebase.

View in Datadog  Leave us feedback  Documentation

response = list_tag_configurations(opts)
@api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
if @api_client.get_attribute_from_path(response, "data").length < page_size
break
end
@api_client.set_attribute_from_path(api_version, opts, "page_cursor", String, @api_client.get_attribute_from_path(response, "meta.pagination.next_cursor"))
end
end

# List tags by metric name.
#
# @see #list_tags_by_metric_name_with_http_info
Expand Down
Loading
Loading