Add mandatory filter env parameter to APM services endpoint (#3477)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -71059,6 +71059,14 @@ paths:
   /api/v2/apm/services:
     get:
       operationId: GetServiceList
+      parameters:
+      - description: Filter services by environment. Can be set to `*` to return all
+          services across all environments.
+        in: query
+        name: filter[env]
+        required: true
+        schema:
+          type: string
       responses:
         '200':
           content:

examples/v2/apm/GetServiceList.ts

@@ -7,8 +7,12 @@ import { client, v2 } from "@datadog/datadog-api-client";
 const configuration = client.createConfiguration();
 const apiInstance = new v2.APMApi(configuration);
 
+const params: v2.APMApiGetServiceListRequest = {
+  filterEnv: "filter[env]",
+};
+
 apiInstance
-  .getServiceList()
+  .getServiceList(params)
   .then((data: v2.ServiceList) => {
     console.log(
       "API called successfully. Returned data: " + JSON.stringify(data)

features/support/scenarios_model_mapping.ts

@@ -3093,6 +3093,10 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
         "operationResponseType": "{}",
     },
     "v2.GetServiceList": {
+        "filterEnv": {
+            "type": "string",
+            "format": "",
+            },
         "operationResponseType": "ServiceList",
     },
     "v2.ListApps": {

features/v2/apm.feature

@@ -9,5 +9,6 @@ Feature: APM
     And a valid "appKeyAuth" key in the system
     And an instance of "APM" API
     And new "GetServiceList" request
+    And request contains "filter[env]" parameter from "REPLACE.ME"
     When the request is sent
     Then the response status is 200 OK

packages/datadog-api-client-v2/apis/APMApi.ts

@@ -1,4 +1,7 @@
-import { BaseAPIRequestFactory } from "../../datadog-api-client-common/baseapi";
+import {
+  BaseAPIRequestFactory,
+  RequiredError,
+} from "../../datadog-api-client-common/baseapi";
 import {
   Configuration,
   applySecurityAuthentication,
@@ -18,10 +21,16 @@ import { ServiceList } from "../models/ServiceList";
 
 export class APMApiRequestFactory extends BaseAPIRequestFactory {
   public async getServiceList(
+    filterEnv: string,
     _options?: Configuration
   ): Promise<RequestContext> {
     const _config = _options || this.configuration;
 
+    // verify required parameter 'filterEnv' is not null or undefined
+    if (filterEnv === null || filterEnv === undefined) {
+      throw new RequiredError("filterEnv", "getServiceList");
+    }
+
     // Path Params
     const localVarPath = "/api/v2/apm/services";
 
@@ -32,6 +41,15 @@ export class APMApiRequestFactory extends BaseAPIRequestFactory {
     requestContext.setHeaderParam("Accept", "application/json");
     requestContext.setHttpConfig(_config.httpConfig);
 
+    // Query Params
+    if (filterEnv !== undefined) {
+      requestContext.setQueryParam(
+        "filter[env]",
+        ObjectSerializer.serialize(filterEnv, "string", ""),
+        ""
+      );
+    }
+
     // Apply auth methods
     applySecurityAuthentication(_config, requestContext, [
       "apiKeyAuth",
@@ -101,6 +119,14 @@ export class APMApiResponseProcessor {
   }
 }
 
+export interface APMApiGetServiceListRequest {
+  /**
+   * Filter services by environment. Can be set to `*` to return all services across all environments.
+   * @type string
+   */
+  filterEnv: string;
+}
+
 export class APMApi {
   private requestFactory: APMApiRequestFactory;
   private responseProcessor: APMApiResponseProcessor;
@@ -120,8 +146,14 @@ export class APMApi {
   /**
    * @param param The request object
    */
-  public getServiceList(options?: Configuration): Promise<ServiceList> {
-    const requestContextPromise = this.requestFactory.getServiceList(options);
+  public getServiceList(
+    param: APMApiGetServiceListRequest,
+    options?: Configuration
+  ): Promise<ServiceList> {
+    const requestContextPromise = this.requestFactory.getServiceList(
+      param.filterEnv,
+      options
+    );
     return requestContextPromise.then((requestContext) => {
       return this.configuration.httpApi
         .send(requestContext)

packages/datadog-api-client-v2/index.ts

@@ -7,7 +7,7 @@ export {
   APIManagementApi,
 } from "./apis/APIManagementApi";
 
-export { APMApi } from "./apis/APMApi";
+export { APMApiGetServiceListRequest, APMApi } from "./apis/APMApi";
 
 export {
   APMRetentionFiltersApiCreateApmRetentionFilterRequest,