Support schema version parameter in Get and List Service Definition endpoints (#1140)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit b220201fda70 · 2023-05-12T13:47:53.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-05-11 14:31:08.955335",
-            "spec_repo_commit": "b6d2ec34"
+            "regenerated": "2023-05-12 13:13:12.164751",
+            "spec_repo_commit": "9eca3996"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-05-11 14:31:08.973217",
-            "spec_repo_commit": "b6d2ec34"
+            "regenerated": "2023-05-12 13:13:12.177759",
+            "spec_repo_commit": "9eca3996"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml
@@ -377,6 +377,13 @@ components:
       required: true
       schema:
         type: string
+    SchemaVersion:
+      description: The schema version desired in the response.
+      in: query
+      name: schema_version
+      required: false
+      schema:
+        $ref: '#/components/schemas/ServiceDefinitionSchemaVersions'
     SecurityFilterID:
       description: The ID of the security filter.
       in: path
@@ -12502,6 +12509,17 @@ components:
       - $ref: '#/components/schemas/ServiceDefinitionV2'
       - $ref: '#/components/schemas/ServiceDefinitionV2Dot1'
       type: object
+    ServiceDefinitionSchemaVersions:
+      description: Schema versions
+      enum:
+      - v1
+      - v2
+      - v2.1
+      type: string
+      x-enum-varnames:
+      - V1
+      - V2
+      - V2_1
     ServiceDefinitionV1:
       deprecated: true
       description: Deprecated - Service definition V1 for providing additional service
@@ -22234,6 +22252,7 @@ paths:
       parameters:
       - $ref: '#/components/parameters/PageSize'
       - $ref: '#/components/parameters/PageNumber'
+      - $ref: '#/components/parameters/SchemaVersion'
       responses:
         '200':
           content:
@@ -22306,6 +22325,7 @@ paths:
       operationId: GetServiceDefinition
       parameters:
       - $ref: '#/components/parameters/ServiceName'
+      - $ref: '#/components/parameters/SchemaVersion'
       responses:
         '200':
           content:
diff --git a/cassettes/v2/Service-Definition_2211895093/Get-a-single-service-definition-returns-OK-response_1436718714/frozen.json b/cassettes/v2/Service-Definition_2211895093/Get-a-single-service-definition-returns-OK-response_1436718714/frozen.json
@@ -1 +1 @@
-"2022-11-14T18:09:34.511Z"
+"2023-05-11T21:16:09.344Z"
diff --git a/cassettes/v2/Service-Definition_2211895093/Get-a-single-service-definition-returns-OK-response_1436718714/recording.har b/cassettes/v2/Service-Definition_2211895093/Get-a-single-service-definition-returns-OK-response_1436718714/recording.har
@@ -8,7 +8,7 @@
     },
     "entries": [
       {
-        "_id": "be8075e0f29791c2ec2b8535512a50d0",
+        "_id": "a15e7aa77c3493f4847cde6b73cc14d9",
         "_order": 0,
         "cache": {},
         "request": {
@@ -21,18 +21,23 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 545,
+          "headersSize": 565,
           "httpVersion": "HTTP/1.1",
           "method": "GET",
-          "queryString": [],
-          "url": "https://api.datadoghq.com/api/v2/services/definitions/service-definition-test"
+          "queryString": [
+            {
+              "name": "schema_version",
+              "value": "v2.1"
+            }
+          ],
+          "url": "https://api.datadoghq.com/api/v2/services/definitions/service-definition-test?schema_version=v2.1"
         },
         "response": {
-          "bodySize": 976,
+          "bodySize": 1017,
           "content": {
             "mimeType": "application/json",
-            "size": 976,
-            "text": "{\"data\":{\"type\":\"service-definition\",\"id\":\"77ae46b484fcfd92dc568170b1c534fe\",\"attributes\":{\"meta\":{\"last-modified-time\":\"2022-11-14T18:03:35Z\",\"github-html-url\":\"\",\"ingestion-source\":\"api\",\"warnings\":[],\"ingested-schema-version\":\"v2\"},\"schema\":{\"schema-version\":\"v2\",\"dd-service\":\"service-definition-test\",\"dd-team\":\"my-team\",\"team\":\"super-team\",\"contacts\":[{\"name\":\"Team Email\",\"type\":\"email\",\"contact\":\"contact@datadoghq.com\"}],\"links\":[{\"name\":\"Runbook\",\"type\":\"runbook\",\"url\":\"https://my-runbook\"}],\"repos\":[{\"name\":\"Source Code\",\"provider\":\"GitHub\",\"url\":\"https://github.com/DataDog/schema\"}],\"docs\":[{\"name\":\"Architecture\",\"provider\":\"google drive\",\"url\":\"https://gdrive/mydoc\"}],\"tags\":[\"service:tag\",\"my:tag\"],\"integrations\":{\"pagerduty\":\"https://my-org.pagerduty.com/service-directory/PMyService\",\"opsgenie\":{\"service-url\":\"https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000\",\"region\":\"US\"}},\"extensions\":{\"myorgextension\":\"extensionvalue\"}}}}}\n"
+            "size": 1017,
+            "text": "{\"data\":{\"type\":\"service-definition\",\"id\":\"77ae46b484fcfd92dc568170b1c534fe\",\"attributes\":{\"meta\":{\"last-modified-time\":\"2023-04-18T16:19:17Z\",\"github-html-url\":\"\",\"ingestion-source\":\"api\",\"origin\":\"unknown\",\"origin-detail\":\"\",\"warnings\":[],\"ingested-schema-version\":\"v2\"},\"schema\":{\"schema-version\":\"v2.1\",\"dd-service\":\"service-definition-test\",\"team\":\"my-team\",\"contacts\":[{\"name\":\"Team Email\",\"type\":\"email\",\"contact\":\"contact@datadoghq.com\"}],\"links\":[{\"name\":\"Runbook\",\"type\":\"runbook\",\"url\":\"https://my-runbook\"},{\"name\":\"Source Code\",\"type\":\"repo\",\"provider\":\"GitHub\",\"url\":\"https://github.com/DataDog/schema\"},{\"name\":\"Architecture\",\"type\":\"doc\",\"provider\":\"google drive\",\"url\":\"https://gdrive/mydoc\"}],\"tags\":[\"service:tag\",\"my:tag\"],\"integrations\":{\"pagerduty\":{\"service-url\":\"https://my-org.pagerduty.com/service-directory/PMyService\"},\"opsgenie\":{\"service-url\":\"https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000\",\"region\":\"US\"}},\"extensions\":{\"myorgextension\":\"extensionvalue\"}}}}}\n"
           },
           "cookies": [],
           "headers": [
@@ -41,14 +46,14 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 628,
+          "headersSize": 657,
           "httpVersion": "HTTP/1.1",
           "redirectURL": "",
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2022-11-14T18:09:34.519Z",
-        "time": 1538
+        "startedDateTime": "2023-05-11T21:16:09.354Z",
+        "time": 248
       }
     ],
     "pages": [],
diff --git a/cassettes/v2/Service-Definition_2211895093/Get-all-service-definitions-returns-OK-response_3667194207/frozen.json b/cassettes/v2/Service-Definition_2211895093/Get-all-service-definitions-returns-OK-response_3667194207/frozen.json
@@ -1 +1 @@
-"2022-10-10T12:54:43.916Z"
+"2023-05-11T21:15:27.277Z"
diff --git a/cassettes/v2/Service-Definition_2211895093/Get-all-service-definitions-returns-OK-response_3667194207/recording.har b/cassettes/v2/Service-Definition_2211895093/Get-all-service-definitions-returns-OK-response_3667194207/recording.har
diff --git a/examples/v2/service-definition/GetServiceDefinition.ts b/examples/v2/service-definition/GetServiceDefinition.ts
@@ -9,6 +9,7 @@ const apiInstance = new v2.ServiceDefinitionApi(configuration);
 
 const params: v2.ServiceDefinitionApiGetServiceDefinitionRequest = {
   serviceName: "service-definition-test",
+  schemaVersion: "v2.1",
 };
 
 apiInstance
diff --git a/examples/v2/service-definition/ListServiceDefinitions.ts b/examples/v2/service-definition/ListServiceDefinitions.ts
@@ -7,8 +7,12 @@ import { client, v2 } from "@datadog/datadog-api-client";
 const configuration = client.createConfiguration();
 const apiInstance = new v2.ServiceDefinitionApi(configuration);
 
+const params: v2.ServiceDefinitionApiListServiceDefinitionsRequest = {
+  schemaVersion: "v2.1",
+};
+
 apiInstance
-  .listServiceDefinitions()
+  .listServiceDefinitions(params)
   .then((data: v2.ServiceDefinitionsListResponse) => {
     console.log(
       "API called successfully. Returned data: " + JSON.stringify(data)
diff --git a/features/support/scenarios_model_mapping.ts b/features/support/scenarios_model_mapping.ts
@@ -4315,6 +4315,10 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
             "type": "number",
             "format": "int64",
             },
+        "schemaVersion": {
+            "type": "ServiceDefinitionSchemaVersions",
+            "format": "",
+            },
         "operationResponseType": "ServiceDefinitionsListResponse",
     },
     "v2.CreateOrUpdateServiceDefinitions": {
@@ -4336,6 +4340,10 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
             "type": "string",
             "format": "",
             },
+        "schemaVersion": {
+            "type": "ServiceDefinitionSchemaVersions",
+            "format": "",
+            },
         "operationResponseType": "ServiceDefinitionGetResponse",
     },
     "v2.GetOnDemandConcurrencyCap": {
diff --git a/features/v2/service_definition.feature b/features/v2/service_definition.feature
@@ -94,17 +94,21 @@ Feature: Service Definition
   Scenario: Get a single service definition returns "OK" response
     Given new "GetServiceDefinition" request
     And request contains "service_name" parameter with value "service-definition-test"
+    And request contains "schema_version" parameter with value "v2.1"
     When the request is sent
     Then the response status is 200 OK
     And the response "data.attributes.meta.ingested-schema-version" is equal to "v2"
+    And the response "data.attributes.schema.schema-version" is equal to "v2.1"
     And the response "data.attributes.schema.dd-service" is equal to "service-definition-test"
 
   @team:DataDog/service-catalog
   Scenario: Get all service definitions returns "OK" response
     Given new "ListServiceDefinitions" request
+    And request contains "schema_version" parameter with value "v2.1"
     When the request is sent
     Then the response status is 200 OK
     And the response "data[0].attributes.meta.ingestion-source" is equal to "api"
+    And the response "data[0].attributes.schema.schema-version" is equal to "v2.1"
 
   @replay-only @skip-validation @team:DataDog/service-catalog @with-pagination
   Scenario: Get all service definitions returns "OK" response with pagination
diff --git a/packages/datadog-api-client-v2/apis/ServiceDefinitionApi.ts b/packages/datadog-api-client-v2/apis/ServiceDefinitionApi.ts
@@ -21,6 +21,7 @@ import { APIErrorResponse } from "../models/APIErrorResponse";
 import { ServiceDefinitionCreateResponse } from "../models/ServiceDefinitionCreateResponse";
 import { ServiceDefinitionData } from "../models/ServiceDefinitionData";
 import { ServiceDefinitionGetResponse } from "../models/ServiceDefinitionGetResponse";
+import { ServiceDefinitionSchemaVersions } from "../models/ServiceDefinitionSchemaVersions";
 import { ServiceDefinitionsCreateRequest } from "../models/ServiceDefinitionsCreateRequest";
 import { ServiceDefinitionsListResponse } from "../models/ServiceDefinitionsListResponse";
 
@@ -103,6 +104,7 @@ export class ServiceDefinitionApiRequestFactory extends BaseAPIRequestFactory {
 
   public async getServiceDefinition(
     serviceName: string,
+    schemaVersion?: ServiceDefinitionSchemaVersions,
     _options?: Configuration
   ): Promise<RequestContext> {
     const _config = _options || this.configuration;
@@ -126,6 +128,18 @@ export class ServiceDefinitionApiRequestFactory extends BaseAPIRequestFactory {
     requestContext.setHeaderParam("Accept", "application/json");
     requestContext.setHttpConfig(_config.httpConfig);
 
+    // Query Params
+    if (schemaVersion !== undefined) {
+      requestContext.setQueryParam(
+        "schema_version",
+        ObjectSerializer.serialize(
+          schemaVersion,
+          "ServiceDefinitionSchemaVersions",
+          ""
+        )
+      );
+    }
+
     // Apply auth methods
     applySecurityAuthentication(_config, requestContext, [
       "apiKeyAuth",
@@ -138,6 +152,7 @@ export class ServiceDefinitionApiRequestFactory extends BaseAPIRequestFactory {
   public async listServiceDefinitions(
     pageSize?: number,
     pageNumber?: number,
+    schemaVersion?: ServiceDefinitionSchemaVersions,
     _options?: Configuration
   ): Promise<RequestContext> {
     const _config = _options || this.configuration;
@@ -166,6 +181,16 @@ export class ServiceDefinitionApiRequestFactory extends BaseAPIRequestFactory {
         ObjectSerializer.serialize(pageNumber, "number", "int64")
       );
     }
+    if (schemaVersion !== undefined) {
+      requestContext.setQueryParam(
+        "schema_version",
+        ObjectSerializer.serialize(
+          schemaVersion,
+          "ServiceDefinitionSchemaVersions",
+          ""
+        )
+      );
+    }
 
     // Apply auth methods
     applySecurityAuthentication(_config, requestContext, [
@@ -447,6 +472,11 @@ export interface ServiceDefinitionApiGetServiceDefinitionRequest {
    * @type string
    */
   serviceName: string;
+  /**
+   * The schema version desired in the response.
+   * @type ServiceDefinitionSchemaVersions
+   */
+  schemaVersion?: ServiceDefinitionSchemaVersions;
 }
 
 export interface ServiceDefinitionApiListServiceDefinitionsRequest {
@@ -460,6 +490,11 @@ export interface ServiceDefinitionApiListServiceDefinitionsRequest {
    * @type number
    */
   pageNumber?: number;
+  /**
+   * The schema version desired in the response.
+   * @type ServiceDefinitionSchemaVersions
+   */
+  schemaVersion?: ServiceDefinitionSchemaVersions;
 }
 
 export class ServiceDefinitionApi {
@@ -533,6 +568,7 @@ export class ServiceDefinitionApi {
   ): Promise<ServiceDefinitionGetResponse> {
     const requestContextPromise = this.requestFactory.getServiceDefinition(
       param.serviceName,
+      param.schemaVersion,
       options
     );
     return requestContextPromise.then((requestContext) => {
@@ -555,6 +591,7 @@ export class ServiceDefinitionApi {
     const requestContextPromise = this.requestFactory.listServiceDefinitions(
       param.pageSize,
       param.pageNumber,
+      param.schemaVersion,
       options
     );
     return requestContextPromise.then((requestContext) => {
@@ -582,6 +619,7 @@ export class ServiceDefinitionApi {
       const requestContext = await this.requestFactory.listServiceDefinitions(
         param.pageSize,
         param.pageNumber,
+        param.schemaVersion,
         options
       );
       const responseContext = await this.configuration.httpApi.send(
diff --git a/packages/datadog-api-client-v2/index.ts b/packages/datadog-api-client-v2/index.ts
@@ -1167,6 +1167,7 @@ export { ServiceDefinitionDataAttributes } from "./models/ServiceDefinitionDataA
 export { ServiceDefinitionGetResponse } from "./models/ServiceDefinitionGetResponse";
 export { ServiceDefinitionMeta } from "./models/ServiceDefinitionMeta";
 export { ServiceDefinitionSchema } from "./models/ServiceDefinitionSchema";
+export { ServiceDefinitionSchemaVersions } from "./models/ServiceDefinitionSchemaVersions";
 export { ServiceDefinitionsCreateRequest } from "./models/ServiceDefinitionsCreateRequest";
 export { ServiceDefinitionsListResponse } from "./models/ServiceDefinitionsListResponse";
 export { ServiceDefinitionV1 } from "./models/ServiceDefinitionV1";
diff --git a/packages/datadog-api-client-v2/models/ObjectSerializer.ts b/packages/datadog-api-client-v2/models/ObjectSerializer.ts
@@ -1097,6 +1097,7 @@ const enumsMap: { [key: string]: any[] } = {
     "partial_replacement_from_beginning",
     "partial_replacement_from_end",
   ],
+  ServiceDefinitionSchemaVersions: ["v1", "v2", "v2.1"],
   ServiceDefinitionV1ResourceType: [
     "doc",
     "wiki",
diff --git a/packages/datadog-api-client-v2/models/ServiceDefinitionSchemaVersions.ts b/packages/datadog-api-client-v2/models/ServiceDefinitionSchemaVersions.ts
@@ -0,0 +1,20 @@
+/**
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2020-Present Datadog, Inc.
+ */
+
+import { UnparsedObject } from "../../datadog-api-client-common/util";
+
+/**
+ * Schema versions
+ */
+
+export type ServiceDefinitionSchemaVersions =
+  | typeof V1
+  | typeof V2
+  | typeof V2_1
+  | UnparsedObject;
+export const V1 = "v1";
+export const V2 = "v2";
+export const V2_1 = "v2.1";

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.4",`
`7`		`- "regenerated": "2023-05-11 14:31:08.955335",`
`8`		`- "spec_repo_commit": "b6d2ec34"`
	`7`	`+ "regenerated": "2023-05-12 13:13:12.164751",`
	`8`	`+ "spec_repo_commit": "9eca3996"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.4",`
`12`		`- "regenerated": "2023-05-11 14:31:08.973217",`
`13`		`- "spec_repo_commit": "b6d2ec34"`
	`12`	`+ "regenerated": "2023-05-12 13:13:12.177759",`
	`13`	`+ "spec_repo_commit": "9eca3996"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-"2022-11-14T18:09:34.511Z"`
	`1`	`+"2023-05-11T21:16:09.344Z"`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-"2022-10-10T12:54:43.916Z"`
	`1`	`+"2023-05-11T21:15:27.277Z"`