Skip to content

Commit ef9c8db

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add mandatory filter env parameter to APM services endpoint (#3005)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 0646c74 commit ef9c8db

5 files changed

Lines changed: 22 additions & 4 deletions

File tree

.generator/schemas/v2/openapi.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71059,6 +71059,14 @@ paths:
7105971059
/api/v2/apm/services:
7106071060
get:
7106171061
operationId: GetServiceList
71062+
parameters:
71063+
- description: Filter services by environment. Can be set to `*` to return all
71064+
services across all environments.
71065+
in: query
71066+
name: filter[env]
71067+
required: true
71068+
schema:
71069+
type: string
7106271070
responses:
7106371071
'200':
7106471072
content:

examples/v2/apm/GetServiceList.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
require "datadog_api_client"
44
api_instance = DatadogAPIClient::V2::APMAPI.new
5-
p api_instance.get_service_list()
5+
p api_instance.get_service_list("filter[env]")

features/scenarios_model_mapping.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1108,6 +1108,9 @@
11081108
"filter_id" => "String",
11091109
"body" => "RetentionFilterUpdateRequest",
11101110
},
1111+
"v2.GetServiceList" => {
1112+
"filter_env" => "String",
1113+
},
11111114
"v2.DeleteApps" => {
11121115
"body" => "DeleteAppsRequest",
11131116
},

features/v2/apm.feature

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@ Feature: APM
99
And a valid "appKeyAuth" key in the system
1010
And an instance of "APM" API
1111
And new "GetServiceList" request
12+
And request contains "filter[env]" parameter from "REPLACE.ME"
1213
When the request is sent
1314
Then the response status is 200 OK

lib/datadog_api_client/v2/api/apm_api.rb

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,24 +26,30 @@ def initialize(api_client = DatadogAPIClient::APIClient.default)
2626
# Get service list.
2727
#
2828
# @see #get_service_list_with_http_info
29-
def get_service_list(opts = {})
30-
data, _status_code, _headers = get_service_list_with_http_info(opts)
29+
def get_service_list(filter_env, opts = {})
30+
data, _status_code, _headers = get_service_list_with_http_info(filter_env, opts)
3131
data
3232
end
3333

3434
# Get service list.
35+
# @param filter_env [String] Filter services by environment. Can be set to `*` to return all services across all environments.
3536
# @param opts [Hash] the optional parameters
3637
# @return [Array<(ServiceList, Integer, Hash)>] ServiceList data, response status code and response headers
37-
def get_service_list_with_http_info(opts = {})
38+
def get_service_list_with_http_info(filter_env, opts = {})
3839

3940
if @api_client.config.debugging
4041
@api_client.config.logger.debug 'Calling API: APMAPI.get_service_list ...'
4142
end
43+
# verify the required parameter 'filter_env' is set
44+
if @api_client.config.client_side_validation && filter_env.nil?
45+
fail ArgumentError, "Missing the required parameter 'filter_env' when calling APMAPI.get_service_list"
46+
end
4247
# resource path
4348
local_var_path = '/api/v2/apm/services'
4449

4550
# query parameters
4651
query_params = opts[:query_params] || {}
52+
query_params[:'filter[env]'] = filter_env
4753

4854
# header parameters
4955
header_params = opts[:header_params] || {}

0 commit comments

Comments
 (0)