Rename service-type to type and change it to an enum field (#1373)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit d1e66e206e55 · 2023-10-12T23:23:07.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
Co-authored-by: api-clients-generation-pipeline[bot] &lt;54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-12 18:33:15.737741",
-            "spec_repo_commit": "1ddbcdce"
+            "regenerated": "2023-10-12 21:14:51.256355",
+            "spec_repo_commit": "d4c17bf0"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-12 18:33:15.759453",
-            "spec_repo_commit": "1ddbcdce"
+            "regenerated": "2023-10-12 21:14:51.274723",
+            "spec_repo_commit": "d4c17bf0"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml
@@ -15836,11 +15836,6 @@ components:
           type: array
         schema-version:
           $ref: '#/components/schemas/ServiceDefinitionV2Dot2Version'
-        service-type:
-          description: 'The type of service. Datadog recognizes the following service
-            types: `database`, `cache`, `function`, `web`, `browser`, and `mobile`.'
-          example: web
-          type: string
         tags:
           description: A set of custom tags.
           example:
@@ -15858,6 +15853,8 @@ components:
           description: Importance of the service.
           example: High
           type: string
+        type:
+          $ref: '#/components/schemas/ServiceDefinitionV2Dot2Type'
       required:
       - schema-version
       - dd-service
@@ -15945,6 +15942,26 @@ components:
           example: https://my-org.pagerduty.com/service-directory/PMyService
           type: string
       type: object
+    ServiceDefinitionV2Dot2Type:
+      description: The type of service.
+      enum:
+      - web
+      - db
+      - cache
+      - function
+      - browser
+      - mobile
+      - custom
+      example: web
+      type: string
+      x-enum-varnames:
+      - WEB
+      - DB
+      - CACHE
+      - FUNCTION
+      - BROSWER
+      - MOBILE
+      - CUSTOM
     ServiceDefinitionV2Dot2Version:
       default: v2.2
       description: Schema version being used.
diff --git a/examples/v2/service-definition/CreateOrUpdateServiceDefinitions.ts b/examples/v2/service-definition/CreateOrUpdateServiceDefinitions.ts
@@ -43,10 +43,10 @@ const params: v2.ServiceDefinitionApiCreateOrUpdateServiceDefinitionsRequest = {
       },
     ],
     schemaVersion: "v2.2",
-    serviceType: "web",
     tags: ["my:tag", "service:tag"],
     team: "my-team",
     tier: "High",
+    type: "web",
   },
 };
 
diff --git a/features/v2/service_definition.feature b/features/v2/service_definition.feature
@@ -10,21 +10,21 @@ Feature: Service Definition
   @generated @skip @team:DataDog/service-catalog
   Scenario: Create or update service definition returns "Bad Request" response
     Given new "CreateOrUpdateServiceDefinitions" request
-    And body with value {"application": "my-app", "contacts": [{"contact": "https://teams.microsoft.com/myteam", "name": "My team channel", "type": "slack"}], "dd-service": "my-service", "description": "My service description", "extensions": {"myorg/extension": "extensionValue"}, "integrations": {"opsgenie": {"region": "US", "service-url": "https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000"}, "pagerduty": {"service-url": "https://my-org.pagerduty.com/service-directory/PMyService"}}, "langauges": ["dotnet", "go", "java", "js", "php", "python", "ruby", "c++"], "lifecycle": "sandbox", "links": [{"name": "Runbook", "provider": "Github", "type": "runbook", "url": "https://my-runbook"}], "schema-version": "v2.2", "service-type": "web", "tags": ["my:tag", "service:tag"], "team": "my-team", "tier": "High"}
+    And body with value {"application": "my-app", "contacts": [{"contact": "https://teams.microsoft.com/myteam", "name": "My team channel", "type": "slack"}], "dd-service": "my-service", "description": "My service description", "extensions": {"myorg/extension": "extensionValue"}, "integrations": {"opsgenie": {"region": "US", "service-url": "https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000"}, "pagerduty": {"service-url": "https://my-org.pagerduty.com/service-directory/PMyService"}}, "langauges": ["dotnet", "go", "java", "js", "php", "python", "ruby", "c++"], "lifecycle": "sandbox", "links": [{"name": "Runbook", "provider": "Github", "type": "runbook", "url": "https://my-runbook"}], "schema-version": "v2.2", "tags": ["my:tag", "service:tag"], "team": "my-team", "tier": "High", "type": "web"}
     When the request is sent
     Then the response status is 400 Bad Request
 
   @generated @skip @team:DataDog/service-catalog
   Scenario: Create or update service definition returns "CREATED" response
     Given new "CreateOrUpdateServiceDefinitions" request
-    And body with value {"application": "my-app", "contacts": [{"contact": "https://teams.microsoft.com/myteam", "name": "My team channel", "type": "slack"}], "dd-service": "my-service", "description": "My service description", "extensions": {"myorg/extension": "extensionValue"}, "integrations": {"opsgenie": {"region": "US", "service-url": "https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000"}, "pagerduty": {"service-url": "https://my-org.pagerduty.com/service-directory/PMyService"}}, "langauges": ["dotnet", "go", "java", "js", "php", "python", "ruby", "c++"], "lifecycle": "sandbox", "links": [{"name": "Runbook", "provider": "Github", "type": "runbook", "url": "https://my-runbook"}], "schema-version": "v2.2", "service-type": "web", "tags": ["my:tag", "service:tag"], "team": "my-team", "tier": "High"}
+    And body with value {"application": "my-app", "contacts": [{"contact": "https://teams.microsoft.com/myteam", "name": "My team channel", "type": "slack"}], "dd-service": "my-service", "description": "My service description", "extensions": {"myorg/extension": "extensionValue"}, "integrations": {"opsgenie": {"region": "US", "service-url": "https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000"}, "pagerduty": {"service-url": "https://my-org.pagerduty.com/service-directory/PMyService"}}, "langauges": ["dotnet", "go", "java", "js", "php", "python", "ruby", "c++"], "lifecycle": "sandbox", "links": [{"name": "Runbook", "provider": "Github", "type": "runbook", "url": "https://my-runbook"}], "schema-version": "v2.2", "tags": ["my:tag", "service:tag"], "team": "my-team", "tier": "High", "type": "web"}
     When the request is sent
     Then the response status is 200 CREATED
 
   @generated @skip @team:DataDog/service-catalog
   Scenario: Create or update service definition returns "Conflict" response
     Given new "CreateOrUpdateServiceDefinitions" request
-    And body with value {"application": "my-app", "contacts": [{"contact": "https://teams.microsoft.com/myteam", "name": "My team channel", "type": "slack"}], "dd-service": "my-service", "description": "My service description", "extensions": {"myorg/extension": "extensionValue"}, "integrations": {"opsgenie": {"region": "US", "service-url": "https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000"}, "pagerduty": {"service-url": "https://my-org.pagerduty.com/service-directory/PMyService"}}, "langauges": ["dotnet", "go", "java", "js", "php", "python", "ruby", "c++"], "lifecycle": "sandbox", "links": [{"name": "Runbook", "provider": "Github", "type": "runbook", "url": "https://my-runbook"}], "schema-version": "v2.2", "service-type": "web", "tags": ["my:tag", "service:tag"], "team": "my-team", "tier": "High"}
+    And body with value {"application": "my-app", "contacts": [{"contact": "https://teams.microsoft.com/myteam", "name": "My team channel", "type": "slack"}], "dd-service": "my-service", "description": "My service description", "extensions": {"myorg/extension": "extensionValue"}, "integrations": {"opsgenie": {"region": "US", "service-url": "https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000"}, "pagerduty": {"service-url": "https://my-org.pagerduty.com/service-directory/PMyService"}}, "langauges": ["dotnet", "go", "java", "js", "php", "python", "ruby", "c++"], "lifecycle": "sandbox", "links": [{"name": "Runbook", "provider": "Github", "type": "runbook", "url": "https://my-runbook"}], "schema-version": "v2.2", "tags": ["my:tag", "service:tag"], "team": "my-team", "tier": "High", "type": "web"}
     When the request is sent
     Then the response status is 409 Conflict
 
diff --git a/packages/datadog-api-client-v2/index.ts b/packages/datadog-api-client-v2/index.ts
@@ -1403,6 +1403,7 @@ export { ServiceDefinitionV2Dot2Link } from "./models/ServiceDefinitionV2Dot2Lin
 export { ServiceDefinitionV2Dot2Opsgenie } from "./models/ServiceDefinitionV2Dot2Opsgenie";
 export { ServiceDefinitionV2Dot2OpsgenieRegion } from "./models/ServiceDefinitionV2Dot2OpsgenieRegion";
 export { ServiceDefinitionV2Dot2Pagerduty } from "./models/ServiceDefinitionV2Dot2Pagerduty";
+export { ServiceDefinitionV2Dot2Type } from "./models/ServiceDefinitionV2Dot2Type";
 export { ServiceDefinitionV2Dot2Version } from "./models/ServiceDefinitionV2Dot2Version";
 export { ServiceDefinitionV2Email } from "./models/ServiceDefinitionV2Email";
 export { ServiceDefinitionV2EmailType } from "./models/ServiceDefinitionV2EmailType";
diff --git a/packages/datadog-api-client-v2/models/ObjectSerializer.ts b/packages/datadog-api-client-v2/models/ObjectSerializer.ts
@@ -1314,6 +1314,15 @@ const enumsMap: { [key: string]: any[] } = {
   ServiceDefinitionV2Dot1SlackType: ["slack"],
   ServiceDefinitionV2Dot1Version: ["v2.1"],
   ServiceDefinitionV2Dot2OpsgenieRegion: ["US", "EU"],
+  ServiceDefinitionV2Dot2Type: [
+    "web",
+    "db",
+    "cache",
+    "function",
+    "browser",
+    "mobile",
+    "custom",
+  ],
   ServiceDefinitionV2Dot2Version: ["v2.2"],
   ServiceDefinitionV2EmailType: ["email"],
   ServiceDefinitionV2LinkType: [
diff --git a/packages/datadog-api-client-v2/models/ServiceDefinitionV2Dot2.ts b/packages/datadog-api-client-v2/models/ServiceDefinitionV2Dot2.ts
@@ -6,6 +6,7 @@
 import { ServiceDefinitionV2Dot2Contact } from "./ServiceDefinitionV2Dot2Contact";
 import { ServiceDefinitionV2Dot2Integrations } from "./ServiceDefinitionV2Dot2Integrations";
 import { ServiceDefinitionV2Dot2Link } from "./ServiceDefinitionV2Dot2Link";
+import { ServiceDefinitionV2Dot2Type } from "./ServiceDefinitionV2Dot2Type";
 import { ServiceDefinitionV2Dot2Version } from "./ServiceDefinitionV2Dot2Version";
 
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
@@ -54,10 +55,6 @@ export class ServiceDefinitionV2Dot2 {
    * Schema version being used.
    */
   "schemaVersion": ServiceDefinitionV2Dot2Version;
-  /**
-   * The type of service. Datadog recognizes the following service types: `database`, `cache`, `function`, `web`, `browser`, and `mobile`.
-   */
-  "serviceType"?: string;
   /**
    * A set of custom tags.
    */
@@ -70,6 +67,10 @@ export class ServiceDefinitionV2Dot2 {
    * Importance of the service.
    */
   "tier"?: string;
+  /**
+   * The type of service.
+   */
+  "type"?: ServiceDefinitionV2Dot2Type;
 
   /**
    * @ignore
@@ -122,10 +123,6 @@ export class ServiceDefinitionV2Dot2 {
       type: "ServiceDefinitionV2Dot2Version",
       required: true,
     },
-    serviceType: {
-      baseName: "service-type",
-      type: "string",
-    },
     tags: {
       baseName: "tags",
       type: "Array<string>",
@@ -138,6 +135,10 @@ export class ServiceDefinitionV2Dot2 {
       baseName: "tier",
       type: "string",
     },
+    type: {
+      baseName: "type",
+      type: "ServiceDefinitionV2Dot2Type",
+    },
   };
 
   /**
diff --git a/packages/datadog-api-client-v2/models/ServiceDefinitionV2Dot2Type.ts b/packages/datadog-api-client-v2/models/ServiceDefinitionV2Dot2Type.ts
@@ -0,0 +1,28 @@
+/**
+ * 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";
+
+/**
+ * The type of service.
+ */
+
+export type ServiceDefinitionV2Dot2Type =
+  | typeof WEB
+  | typeof DB
+  | typeof CACHE
+  | typeof FUNCTION
+  | typeof BROSWER
+  | typeof MOBILE
+  | typeof CUSTOM
+  | UnparsedObject;
+export const WEB = "web";
+export const DB = "db";
+export const CACHE = "cache";
+export const FUNCTION = "function";
+export const BROSWER = "browser";
+export const MOBILE = "mobile";
+export const CUSTOM = "custom";

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.6",`
`7`		`- "regenerated": "2023-10-12 18:33:15.737741",`
`8`		`- "spec_repo_commit": "1ddbcdce"`
	`7`	`+ "regenerated": "2023-10-12 21:14:51.256355",`
	`8`	`+ "spec_repo_commit": "d4c17bf0"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.6",`
`12`		`- "regenerated": "2023-10-12 18:33:15.759453",`
`13`		`- "spec_repo_commit": "1ddbcdce"`
	`12`	`+ "regenerated": "2023-10-12 21:14:51.274723",`
	`13`	`+ "spec_repo_commit": "d4c17bf0"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`