Split the synthetics request port field into a oneOf (#2157)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-09-10 08:48:30.716171",
-            "spec_repo_commit": "b32bee1b"
+            "regenerated": "2024-09-11 19:15:20.742421",
+            "spec_repo_commit": "3288a6f0"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-09-10 08:48:30.742094",
-            "spec_repo_commit": "b32bee1b"
+            "regenerated": "2024-09-11 19:15:20.759805",
+            "spec_repo_commit": "3288a6f0"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -16352,8 +16352,7 @@ components:
           description: Persist cookies across redirects.
           type: boolean
         port:
-          description: Port to use when performing the test.
-          type: string
+          $ref: '#/components/schemas/SyntheticsTestRequestPort'
         proxy:
           $ref: '#/components/schemas/SyntheticsTestRequestProxy'
         query:
@@ -16457,6 +16456,15 @@ components:
           description: Date of update of the certificate or key, ISO format.
           type: string
       type: object
+    SyntheticsTestRequestNumericalPort:
+      description: Integer Port number to use when performing the test.
+      format: int64
+      type: integer
+    SyntheticsTestRequestPort:
+      description: Port to use when performing the test.
+      oneOf:
+      - $ref: '#/components/schemas/SyntheticsTestRequestNumericalPort'
+      - $ref: '#/components/schemas/SyntheticsTestRequestVariablePort'
     SyntheticsTestRequestProxy:
       description: The proxy to perform the test.
       properties:
@@ -16469,6 +16477,10 @@ components:
       required:
       - url
       type: object
+    SyntheticsTestRequestVariablePort:
+      description: String Port number to use when performing the test. Supports templated
+        variables.
+      type: string
     SyntheticsTiming:
       description: 'Object containing all metrics and their values collected for a
         Synthetic API test.

docs/datadog_api_client.v1.model.rst

@@ -4771,6 +4771,13 @@ datadog\_api\_client.v1.model.synthetics\_test\_request\_certificate\_item modul
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v1.model.synthetics\_test\_request\_port module
+--------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_test_request_port
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v1.model.synthetics\_test\_request\_proxy module
 ---------------------------------------------------------------------
 

examples/v1/synthetics/CreateSyntheticsAPITest_1072503741.py

@@ -25,7 +25,7 @@
         ],
         request=SyntheticsTestRequest(
             host="datadoghq.com",
-            port="443",
+            port="{{ DATADOG_PORT }}",
         ),
     ),
     locations=[

examples/v1/synthetics/CreateSyntheticsAPITest_1279271422.py

@@ -99,7 +99,7 @@
                 ],
                 request=SyntheticsTestRequest(
                     host="grpcbin.test.k6.io",
-                    port="9000",
+                    port=9000,
                     service="grpcbin.GRPCBin",
                     method="Index",
                     message="{}",

examples/v1/synthetics/CreateSyntheticsAPITest_1402674167.py

@@ -38,7 +38,7 @@
         ],
         request=SyntheticsTestRequest(
             host="localhost",
-            port="50051",
+            port=50051,
             service="Hello",
             method="GET",
             message="",

examples/v1/synthetics/CreateSyntheticsAPITest_3829801148.py

@@ -33,7 +33,7 @@
         request=SyntheticsTestRequest(
             host="https://datadoghq.com",
             message="message",
-            port="443",
+            port=443,
         ),
     ),
     locations=[

src/datadog_api_client/v1/model/synthetics_test_request.py

@@ -22,6 +22,7 @@
     from datadog_api_client.v1.model.synthetics_test_headers import SyntheticsTestHeaders
     from datadog_api_client.v1.model.synthetics_test_options_http_version import SyntheticsTestOptionsHTTPVersion
     from datadog_api_client.v1.model.synthetics_test_metadata import SyntheticsTestMetadata
+    from datadog_api_client.v1.model.synthetics_test_request_port import SyntheticsTestRequestPort
     from datadog_api_client.v1.model.synthetics_test_request_proxy import SyntheticsTestRequestProxy
     from datadog_api_client.v1.model.synthetics_basic_auth_web import SyntheticsBasicAuthWeb
     from datadog_api_client.v1.model.synthetics_basic_auth_sigv4 import SyntheticsBasicAuthSigv4
@@ -49,6 +50,7 @@ def openapi_types(_):
         from datadog_api_client.v1.model.synthetics_test_headers import SyntheticsTestHeaders
         from datadog_api_client.v1.model.synthetics_test_options_http_version import SyntheticsTestOptionsHTTPVersion
         from datadog_api_client.v1.model.synthetics_test_metadata import SyntheticsTestMetadata
+        from datadog_api_client.v1.model.synthetics_test_request_port import SyntheticsTestRequestPort
         from datadog_api_client.v1.model.synthetics_test_request_proxy import SyntheticsTestRequestProxy
 
         return {
@@ -74,7 +76,7 @@ def openapi_types(_):
             "no_saving_response_body": (bool,),
             "number_of_packets": (int,),
             "persist_cookies": (bool,),
-            "port": (str,),
+            "port": (SyntheticsTestRequestPort,),
             "proxy": (SyntheticsTestRequestProxy,),
             "query": (dict,),
             "servername": (str,),
@@ -150,7 +152,7 @@ def __init__(
         no_saving_response_body: Union[bool, UnsetType] = unset,
         number_of_packets: Union[int, UnsetType] = unset,
         persist_cookies: Union[bool, UnsetType] = unset,
-        port: Union[str, UnsetType] = unset,
+        port: Union[SyntheticsTestRequestPort, int, str, UnsetType] = unset,
         proxy: Union[SyntheticsTestRequestProxy, UnsetType] = unset,
         query: Union[dict, UnsetType] = unset,
         servername: Union[str, UnsetType] = unset,
@@ -230,7 +232,7 @@ def __init__(
         :type persist_cookies: bool, optional
 
         :param port: Port to use when performing the test.
-        :type port: str, optional
+        :type port: SyntheticsTestRequestPort, optional
 
         :param proxy: The proxy to perform the test.
         :type proxy: SyntheticsTestRequestProxy, optional

src/datadog_api_client/v1/model/synthetics_test_request_port.py

@@ -0,0 +1,34 @@
+# 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 (
+    ModelComposed,
+    cached_property,
+)
+
+
+class SyntheticsTestRequestPort(ModelComposed):
+    def __init__(self, **kwargs):
+        """
+        Port to use when performing the test.
+        """
+        super().__init__(kwargs)
+
+    @cached_property
+    def _composed_schemas(_):
+        # we need this here to make our import statements work
+        # we must store _composed_schemas in here so the code is only run
+        # when we invoke this method. If we kept this at the class
+        # level we would get an error because the class level
+        # code would be run when this module is imported, and these composed
+        # classes don't exist yet because their module has not finished
+        # loading
+        return {
+            "oneOf": [
+                int,
+                str,
+            ],
+        }

src/datadog_api_client/v1/models/__init__.py

@@ -784,6 +784,7 @@
 from datadog_api_client.v1.model.synthetics_test_request_body_type import SyntheticsTestRequestBodyType
 from datadog_api_client.v1.model.synthetics_test_request_certificate import SyntheticsTestRequestCertificate
 from datadog_api_client.v1.model.synthetics_test_request_certificate_item import SyntheticsTestRequestCertificateItem
+from datadog_api_client.v1.model.synthetics_test_request_port import SyntheticsTestRequestPort
 from datadog_api_client.v1.model.synthetics_test_request_proxy import SyntheticsTestRequestProxy
 from datadog_api_client.v1.model.synthetics_timing import SyntheticsTiming
 from datadog_api_client.v1.model.synthetics_trigger_body import SyntheticsTriggerBody
@@ -1676,6 +1677,7 @@
     "SyntheticsTestRequestBodyType",
     "SyntheticsTestRequestCertificate",
     "SyntheticsTestRequestCertificateItem",
+    "SyntheticsTestRequestPort",
     "SyntheticsTestRequestProxy",
     "SyntheticsTiming",
     "SyntheticsTriggerBody",