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

Co-authored-by: ci.datadog-api-spec <[email protected]>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-12 18:33:22.507320",
-            "spec_repo_commit": "1ddbcdce"
+            "regenerated": "2023-10-12 21:14:48.669425",
+            "spec_repo_commit": "d4c17bf0"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-12 18:33:22.526135",
-            "spec_repo_commit": "1ddbcdce"
+            "regenerated": "2023-10-12 21:14:48.718184",
+            "spec_repo_commit": "d4c17bf0"
         }
     }
 }

.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.

docs/datadog_api_client.v2.model.rst

@@ -7043,6 +7043,13 @@ service\_definition\_v2\_dot2\_pagerduty
    :members:
    :show-inheritance:
 
+service\_definition\_v2\_dot2\_type
+-----------------------------------
+
+.. automodule:: datadog_api_client.v2.model.service_definition_v2_dot2_type
+   :members:
+   :show-inheritance:
+
 service\_definition\_v2\_email
 ------------------------------
 

examples/v2/service-definition/CreateOrUpdateServiceDefinitions.py

@@ -11,6 +11,7 @@
 from datadog_api_client.v2.model.service_definition_v2_dot2_opsgenie import ServiceDefinitionV2Dot2Opsgenie
 from datadog_api_client.v2.model.service_definition_v2_dot2_opsgenie_region import ServiceDefinitionV2Dot2OpsgenieRegion
 from datadog_api_client.v2.model.service_definition_v2_dot2_pagerduty import ServiceDefinitionV2Dot2Pagerduty
+from datadog_api_client.v2.model.service_definition_v2_dot2_type import ServiceDefinitionV2Dot2Type
 from datadog_api_client.v2.model.service_definition_v2_dot2_version import ServiceDefinitionV2Dot2Version
 
 body = ServiceDefinitionV2Dot2(
@@ -54,13 +55,13 @@
         ),
     ],
     schema_version=ServiceDefinitionV2Dot2Version.V2_2,
-    service_type="web",
     tags=[
         "my:tag",
         "service:tag",
     ],
     team="my-team",
     tier="High",
+    type=ServiceDefinitionV2Dot2Type.WEB,
 )
 
 configuration = Configuration()

src/datadog_api_client/v2/model/service_definition_schema.py

@@ -75,8 +75,8 @@ def __init__(self, **kwargs):
         :param langauges: The service's programming language. Datadog recognizes the following languages: `dotnet`, `go`, `java`, `js`, `php`, `python`, `ruby`, and `c++`.
         :type langauges: [str], optional
 
-        :param service_type: The type of service. Datadog recognizes the following service types: `database`, `cache`, `function`, `web`, `browser`, and `mobile`.
-        :type service_type: str, optional
+        :param type: The type of service.
+        :type type: ServiceDefinitionV2Dot2Type, optional
         """
         super().__init__(kwargs)
 

src/datadog_api_client/v2/model/service_definition_v2_dot2.py

@@ -21,6 +21,7 @@
     from datadog_api_client.v2.model.service_definition_v2_dot2_integrations import ServiceDefinitionV2Dot2Integrations
     from datadog_api_client.v2.model.service_definition_v2_dot2_link import ServiceDefinitionV2Dot2Link
     from datadog_api_client.v2.model.service_definition_v2_dot2_version import ServiceDefinitionV2Dot2Version
+    from datadog_api_client.v2.model.service_definition_v2_dot2_type import ServiceDefinitionV2Dot2Type
 
 
 class ServiceDefinitionV2Dot2(ModelNormal):
@@ -32,6 +33,7 @@ def openapi_types(_):
         )
         from datadog_api_client.v2.model.service_definition_v2_dot2_link import ServiceDefinitionV2Dot2Link
         from datadog_api_client.v2.model.service_definition_v2_dot2_version import ServiceDefinitionV2Dot2Version
+        from datadog_api_client.v2.model.service_definition_v2_dot2_type import ServiceDefinitionV2Dot2Type
 
         return {
             "application": (str,),
@@ -58,10 +60,10 @@ def openapi_types(_):
             "lifecycle": (str,),
             "links": ([ServiceDefinitionV2Dot2Link],),
             "schema_version": (ServiceDefinitionV2Dot2Version,),
-            "service_type": (str,),
             "tags": ([str],),
             "team": (str,),
             "tier": (str,),
+            "type": (ServiceDefinitionV2Dot2Type,),
         }
 
     attribute_map = {
@@ -75,10 +77,10 @@ def openapi_types(_):
         "lifecycle": "lifecycle",
         "links": "links",
         "schema_version": "schema-version",
-        "service_type": "service-type",
         "tags": "tags",
         "team": "team",
         "tier": "tier",
+        "type": "type",
     }
 
     def __init__(
@@ -93,10 +95,10 @@ def __init__(
         langauges: Union[List[str], UnsetType] = unset,
         lifecycle: Union[str, UnsetType] = unset,
         links: Union[List[ServiceDefinitionV2Dot2Link], UnsetType] = unset,
-        service_type: Union[str, UnsetType] = unset,
         tags: Union[List[str], UnsetType] = unset,
         team: Union[str, UnsetType] = unset,
         tier: Union[str, UnsetType] = unset,
+        type: Union[ServiceDefinitionV2Dot2Type, UnsetType] = unset,
         **kwargs,
     ):
         """
@@ -132,9 +134,6 @@ def __init__(
         :param schema_version: Schema version being used.
         :type schema_version: ServiceDefinitionV2Dot2Version
 
-        :param service_type: The type of service. Datadog recognizes the following service types: ``database`` , ``cache`` , ``function`` , ``web`` , ``browser`` , and ``mobile``.
-        :type service_type: str, optional
-
         :param tags: A set of custom tags.
         :type tags: [str], optional
 
@@ -143,6 +142,9 @@ def __init__(
 
         :param tier: Importance of the service.
         :type tier: str, optional
+
+        :param type: The type of service.
+        :type type: ServiceDefinitionV2Dot2Type, optional
         """
         if application is not unset:
             kwargs["application"] = application
@@ -160,14 +162,14 @@ def __init__(
             kwargs["lifecycle"] = lifecycle
         if links is not unset:
             kwargs["links"] = links
-        if service_type is not unset:
-            kwargs["service_type"] = service_type
         if tags is not unset:
             kwargs["tags"] = tags
         if team is not unset:
             kwargs["team"] = team
         if tier is not unset:
             kwargs["tier"] = tier
+        if type is not unset:
+            kwargs["type"] = type
         super().__init__(kwargs)
 
         self_.dd_service = dd_service

src/datadog_api_client/v2/model/service_definition_v2_dot2_type.py

@@ -0,0 +1,53 @@
+# 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 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+
+from datadog_api_client.model_utils import (
+    ModelSimple,
+    cached_property,
+)
+
+from typing import ClassVar
+
+
+class ServiceDefinitionV2Dot2Type(ModelSimple):
+    """
+    The type of service.
+
+    :param value: Must be one of ["web", "db", "cache", "function", "browser", "mobile", "custom"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "web",
+        "db",
+        "cache",
+        "function",
+        "browser",
+        "mobile",
+        "custom",
+    }
+    WEB: ClassVar["ServiceDefinitionV2Dot2Type"]
+    DB: ClassVar["ServiceDefinitionV2Dot2Type"]
+    CACHE: ClassVar["ServiceDefinitionV2Dot2Type"]
+    FUNCTION: ClassVar["ServiceDefinitionV2Dot2Type"]
+    BROSWER: ClassVar["ServiceDefinitionV2Dot2Type"]
+    MOBILE: ClassVar["ServiceDefinitionV2Dot2Type"]
+    CUSTOM: ClassVar["ServiceDefinitionV2Dot2Type"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+ServiceDefinitionV2Dot2Type.WEB = ServiceDefinitionV2Dot2Type("web")
+ServiceDefinitionV2Dot2Type.DB = ServiceDefinitionV2Dot2Type("db")
+ServiceDefinitionV2Dot2Type.CACHE = ServiceDefinitionV2Dot2Type("cache")
+ServiceDefinitionV2Dot2Type.FUNCTION = ServiceDefinitionV2Dot2Type("function")
+ServiceDefinitionV2Dot2Type.BROSWER = ServiceDefinitionV2Dot2Type("browser")
+ServiceDefinitionV2Dot2Type.MOBILE = ServiceDefinitionV2Dot2Type("mobile")
+ServiceDefinitionV2Dot2Type.CUSTOM = ServiceDefinitionV2Dot2Type("custom")

src/datadog_api_client/v2/model/service_definitions_create_request.py

@@ -45,9 +45,6 @@ def __init__(self, **kwargs):
         :param schema_version: Schema version being used.
         :type schema_version: ServiceDefinitionV2Dot2Version
 
-        :param service_type: The type of service. Datadog recognizes the following service types: `database`, `cache`, `function`, `web`, `browser`, and `mobile`.
-        :type service_type: str, optional
-
         :param tags: A set of custom tags.
         :type tags: [str], optional
 
@@ -57,6 +54,9 @@ def __init__(self, **kwargs):
         :param tier: Importance of the service.
         :type tier: str, optional
 
+        :param type: The type of service.
+        :type type: ServiceDefinitionV2Dot2Type, optional
+
         :param dd_team: Experimental feature. A Team handle that matches a Team in the Datadog Teams product.
         :type dd_team: str, optional
 

src/datadog_api_client/v2/models/__init__.py

@@ -1230,6 +1230,7 @@
 from datadog_api_client.v2.model.service_definition_v2_dot2_opsgenie import ServiceDefinitionV2Dot2Opsgenie
 from datadog_api_client.v2.model.service_definition_v2_dot2_opsgenie_region import ServiceDefinitionV2Dot2OpsgenieRegion
 from datadog_api_client.v2.model.service_definition_v2_dot2_pagerduty import ServiceDefinitionV2Dot2Pagerduty
+from datadog_api_client.v2.model.service_definition_v2_dot2_type import ServiceDefinitionV2Dot2Type
 from datadog_api_client.v2.model.service_definition_v2_dot2_version import ServiceDefinitionV2Dot2Version
 from datadog_api_client.v2.model.service_definition_v2_email import ServiceDefinitionV2Email
 from datadog_api_client.v2.model.service_definition_v2_email_type import ServiceDefinitionV2EmailType
@@ -2419,6 +2420,7 @@
     "ServiceDefinitionV2Dot2Opsgenie",
     "ServiceDefinitionV2Dot2OpsgenieRegion",
     "ServiceDefinitionV2Dot2Pagerduty",
+    "ServiceDefinitionV2Dot2Type",
     "ServiceDefinitionV2Dot2Version",
     "ServiceDefinitionV2Email",
     "ServiceDefinitionV2EmailType",

tests/v2/features/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