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

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.4",
-            "regenerated": "2023-05-11 14:31:13.499049",
-            "spec_repo_commit": "b6d2ec34"
+            "regenerated": "2023-05-12 13:13:08.052638",
+            "spec_repo_commit": "9eca3996"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-05-11 14:31:13.516351",
-            "spec_repo_commit": "b6d2ec34"
+            "regenerated": "2023-05-12 13:13:08.068754",
+            "spec_repo_commit": "9eca3996"
         }
     }
 }

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

docs/datadog_api_client.v2.model.rst

@@ -5664,6 +5664,13 @@ service\_definition\_schema
    :members:
    :show-inheritance:
 
+service\_definition\_schema\_versions
+-------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.service_definition_schema_versions
+   :members:
+   :show-inheritance:
+
 service\_definition\_v1
 -----------------------
 

examples/v2/service-definition/GetServiceDefinition.py

@@ -4,12 +4,14 @@
 
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v2.api.service_definition_api import ServiceDefinitionApi
+from datadog_api_client.v2.model.service_definition_schema_versions import ServiceDefinitionSchemaVersions
 
 configuration = Configuration()
 with ApiClient(configuration) as api_client:
     api_instance = ServiceDefinitionApi(api_client)
     response = api_instance.get_service_definition(
         service_name="service-definition-test",
+        schema_version=ServiceDefinitionSchemaVersions.V2_1,
     )
 
     print(response)

examples/v2/service-definition/ListServiceDefinitions.py

@@ -4,10 +4,13 @@
 
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v2.api.service_definition_api import ServiceDefinitionApi
+from datadog_api_client.v2.model.service_definition_schema_versions import ServiceDefinitionSchemaVersions
 
 configuration = Configuration()
 with ApiClient(configuration) as api_client:
     api_instance = ServiceDefinitionApi(api_client)
-    response = api_instance.list_service_definitions()
+    response = api_instance.list_service_definitions(
+        schema_version=ServiceDefinitionSchemaVersions.V2_1,
+    )
 
     print(response)

src/datadog_api_client/v2/api/service_definition_api.py

@@ -15,6 +15,7 @@
     unset,
 )
 from datadog_api_client.v2.model.service_definitions_list_response import ServiceDefinitionsListResponse
+from datadog_api_client.v2.model.service_definition_schema_versions import ServiceDefinitionSchemaVersions
 from datadog_api_client.v2.model.service_definition_data import ServiceDefinitionData
 from datadog_api_client.v2.model.service_definition_create_response import ServiceDefinitionCreateResponse
 from datadog_api_client.v2.model.service_definitions_create_request import ServiceDefinitionsCreateRequest
@@ -96,6 +97,11 @@ def __init__(self, api_client=None):
                     "attribute": "service_name",
                     "location": "path",
                 },
+                "schema_version": {
+                    "openapi_types": (ServiceDefinitionSchemaVersions,),
+                    "attribute": "schema_version",
+                    "location": "query",
+                },
             },
             headers_map={
                 "accept": ["application/json"],
@@ -125,6 +131,11 @@ def __init__(self, api_client=None):
                     "attribute": "page[number]",
                     "location": "query",
                 },
+                "schema_version": {
+                    "openapi_types": (ServiceDefinitionSchemaVersions,),
+                    "attribute": "schema_version",
+                    "location": "query",
+                },
             },
             headers_map={
                 "accept": ["application/json"],
@@ -170,25 +181,33 @@ def delete_service_definition(
     def get_service_definition(
         self,
         service_name: str,
+        *,
+        schema_version: Union[ServiceDefinitionSchemaVersions, UnsetType] = unset,
     ) -> ServiceDefinitionGetResponse:
         """Get a single service definition.
 
         Get a single service definition from the Datadog Service Catalog.
 
         :param service_name: The name of the service.
         :type service_name: str
+        :param schema_version: The schema version desired in the response.
+        :type schema_version: ServiceDefinitionSchemaVersions, optional
         :rtype: ServiceDefinitionGetResponse
         """
         kwargs: Dict[str, Any] = {}
         kwargs["service_name"] = service_name
 
+        if schema_version is not unset:
+            kwargs["schema_version"] = schema_version
+
         return self._get_service_definition_endpoint.call_with_http_info(**kwargs)
 
     def list_service_definitions(
         self,
         *,
         page_size: Union[int, UnsetType] = unset,
         page_number: Union[int, UnsetType] = unset,
+        schema_version: Union[ServiceDefinitionSchemaVersions, UnsetType] = unset,
     ) -> ServiceDefinitionsListResponse:
         """Get all service definitions.
 
@@ -198,6 +217,8 @@ def list_service_definitions(
         :type page_size: int, optional
         :param page_number: Specific page number to return.
         :type page_number: int, optional
+        :param schema_version: The schema version desired in the response.
+        :type schema_version: ServiceDefinitionSchemaVersions, optional
         :rtype: ServiceDefinitionsListResponse
         """
         kwargs: Dict[str, Any] = {}
@@ -207,13 +228,17 @@ def list_service_definitions(
         if page_number is not unset:
             kwargs["page_number"] = page_number
 
+        if schema_version is not unset:
+            kwargs["schema_version"] = schema_version
+
         return self._list_service_definitions_endpoint.call_with_http_info(**kwargs)
 
     def list_service_definitions_with_pagination(
         self,
         *,
         page_size: Union[int, UnsetType] = unset,
         page_number: Union[int, UnsetType] = unset,
+        schema_version: Union[ServiceDefinitionSchemaVersions, UnsetType] = unset,
     ) -> collections.abc.Iterable[ServiceDefinitionData]:
         """Get all service definitions.
 
@@ -223,6 +248,8 @@ def list_service_definitions_with_pagination(
         :type page_size: int, optional
         :param page_number: Specific page number to return.
         :type page_number: int, optional
+        :param schema_version: The schema version desired in the response.
+        :type schema_version: ServiceDefinitionSchemaVersions, optional
 
         :return: A generator of paginated results.
         :rtype: collections.abc.Iterable[ServiceDefinitionData]
@@ -234,6 +261,9 @@ def list_service_definitions_with_pagination(
         if page_number is not unset:
             kwargs["page_number"] = page_number
 
+        if schema_version is not unset:
+            kwargs["schema_version"] = schema_version
+
         local_page_size = get_attribute_from_path(kwargs, "page_size", 10)
         endpoint = self._list_service_definitions_endpoint
         set_attribute_from_path(kwargs, "page_size", local_page_size, endpoint.params_map)

src/datadog_api_client/v2/model/service_definition_schema_versions.py

@@ -0,0 +1,41 @@
+# 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 ServiceDefinitionSchemaVersions(ModelSimple):
+    """
+    Schema versions
+
+    :param value: Must be one of ["v1", "v2", "v2.1"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "v1",
+        "v2",
+        "v2.1",
+    }
+    V1: ClassVar["ServiceDefinitionSchemaVersions"]
+    V2: ClassVar["ServiceDefinitionSchemaVersions"]
+    V2_1: ClassVar["ServiceDefinitionSchemaVersions"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+ServiceDefinitionSchemaVersions.V1 = ServiceDefinitionSchemaVersions("v1")
+ServiceDefinitionSchemaVersions.V2 = ServiceDefinitionSchemaVersions("v2")
+ServiceDefinitionSchemaVersions.V2_1 = ServiceDefinitionSchemaVersions("v2.1")

src/datadog_api_client/v2/models/__init__.py

@@ -1007,6 +1007,7 @@
 from datadog_api_client.v2.model.service_definition_get_response import ServiceDefinitionGetResponse
 from datadog_api_client.v2.model.service_definition_meta import ServiceDefinitionMeta
 from datadog_api_client.v2.model.service_definition_schema import ServiceDefinitionSchema
+from datadog_api_client.v2.model.service_definition_schema_versions import ServiceDefinitionSchemaVersions
 from datadog_api_client.v2.model.service_definition_v1 import ServiceDefinitionV1
 from datadog_api_client.v2.model.service_definition_v1_contact import ServiceDefinitionV1Contact
 from datadog_api_client.v2.model.service_definition_v1_info import ServiceDefinitionV1Info

tests/v2/cassettes/test_scenarios/test_get_a_single_service_definition_returns_ok_response.frozen

@@ -1 +1 @@
-2022-11-14T18:09:34.511Z
+2023-05-11T21:16:09.344Z

tests/v2/cassettes/test_scenarios/test_get_a_single_service_definition_returns_ok_response.yaml

@@ -5,13 +5,13 @@ interactions:
       accept:
       - application/json
     method: GET
-    uri: https://api.datadoghq.com/api/v2/services/definitions/service-definition-test
+    uri: https://api.datadoghq.com/api/v2/services/definitions/service-definition-test?schema_version=v2.1
   response:
     body:
-      string: '{"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":"[email protected]"}],"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"}}}}}
+      string: '{"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":"[email protected]"}],"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"}}}}}
 
         '
     headers: