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

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:

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

private/bdd_runner/src/support/scenarios_model_mapping.ts

@@ -3103,6 +3103,10 @@ export const ScenariosModelMappings: { [key: string]: OperationMapping } = {
     operationResponseType: "{}",
   },
   "APMApi.V2.GetServiceList": {
+    filterEnv: {
+      type: "string",
+      format: "",
+    },
     operationResponseType: "ServiceList",
   },
   "AppBuilderApi.V2.ListApps": {

services/apm/README.md

@@ -26,8 +26,9 @@ import { v2 } from "@datadog/datadog-api-client-apm";
 
 const configuration = createConfiguration();
 const apiInstance = new APMApiV2(configuration);
+const params = {/* parameters */};
 
-apiInstance.getServiceList().then((data) => {
+apiInstance.getServiceList(params).then((data) => {
     console.log("API called successfully. Returned data: " + JSON.stringify(data));
 }).catch((error) => {
     console.error("Error calling API: " + error);

services/apm/src/v2/APMApi.ts

@@ -36,10 +36,16 @@ 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";
 
@@ -61,6 +67,15 @@ export class APMApiRequestFactory extends BaseAPIRequestFactory {
       requestContext.setHeaderParam("User-Agent", this.userAgent);
     }
 
+    // Query Params
+    if (filterEnv !== undefined) {
+      requestContext.setQueryParam(
+        "filter[env]",
+        serialize(filterEnv, TypingInfo, "string", ""),
+        "",
+      );
+    }
+
     // Apply auth methods
     applySecurityAuthentication(_config, requestContext, [
       "apiKeyAuth",
@@ -128,6 +143,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;
@@ -149,8 +172,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)

services/apm/src/v2/index.ts

@@ -1,4 +1,4 @@
-export { APMApi } from "./APMApi";
+export { APMApiGetServiceListRequest, APMApi } from "./APMApi";
 
 export { APIErrorResponse } from "./models/APIErrorResponse";
 export { ServiceList } from "./models/ServiceList";