Support GRPC unary calls in Synthetics (#1253)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 450eb8eceea7 · 2022-12-09T09:57:32.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": "2022-12-08 13:18:32.017696",
-            "spec_repo_commit": "65b2053a"
+            "regenerated": "2022-12-09 09:29:11.062861",
+            "spec_repo_commit": "68c90324"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-12-08 13:18:32.032677",
-            "spec_repo_commit": "65b2053a"
+            "regenerated": "2022-12-09 09:29:11.074112",
+            "spec_repo_commit": "68c90324"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
@@ -3116,26 +3116,6 @@ components:
       required:
       - message
       type: object
-    HTTPMethod:
-      description: The HTTP method.
-      enum:
-      - GET
-      - POST
-      - PATCH
-      - PUT
-      - DELETE
-      - HEAD
-      - OPTIONS
-      example: GET
-      type: string
-      x-enum-varnames:
-      - GET
-      - POST
-      - PATCH
-      - PUT
-      - DELETE
-      - HEAD
-      - OPTIONS
     HeatMapWidgetDefinition:
       description: The heat map visualization shows metrics aggregated across many
         tags, such as hosts. The more hosts that have a particular value, the darker
@@ -13141,6 +13121,16 @@ components:
       - TYPE_TEXT
       - UPLOAD_FILES
       - WAIT
+    SyntheticsTestCallType:
+      description: The type of gRPC call to perform.
+      enum:
+      - healthcheck
+      - unary
+      example: unary
+      type: string
+      x-enum-varnames:
+      - HEALTHCHECK
+      - UNARY
     SyntheticsTestCiOptions:
       description: CI/CD options for a Synthetic test.
       properties:
@@ -13448,6 +13438,8 @@ components:
           type: string
         bodyType:
           $ref: '#/components/schemas/SyntheticsTestRequestBodyType'
+        callType:
+          $ref: '#/components/schemas/SyntheticsTestCallType'
         certificate:
           $ref: '#/components/schemas/SyntheticsTestRequestCertificate'
         certificateDomains:
@@ -13483,7 +13475,10 @@ components:
         metadata:
           $ref: '#/components/schemas/SyntheticsTestMetadata'
         method:
-          $ref: '#/components/schemas/HTTPMethod'
+          description: Either the HTTP method/verb to use or a gRPC method available
+            on the service set in the `service` field. Required if `subtype` is `HTTP`
+            or if `subtype` is `grpc` and `callType` is `unary`.
+          type: string
         noSavingResponseBody:
           description: Determines whether or not to save the response body.
           type: boolean
@@ -13511,7 +13506,8 @@ components:
             the same IP address and TCP port number.'
           type: string
         service:
-          description: gRPC service on which you want to perform the healthcheck.
+          description: The gRPC service on which you want to perform the gRPC call.
+          example: Greeter
           type: string
         shouldTrackHops:
           description: Turns on a traceroute probe to discover all gateways along
diff --git a/docs/datadog_api_client.v1.model.rst b/docs/datadog_api_client.v1.model.rst
@@ -1107,13 +1107,6 @@ http\_log\_item
    :members:
    :show-inheritance:
 
-http\_method
-------------
-
-.. automodule:: datadog_api_client.v1.model.http_method
-   :members:
-   :show-inheritance:
-
 i\_frame\_widget\_definition
 ----------------------------
 
@@ -3942,6 +3935,13 @@ synthetics\_step\_type
    :members:
    :show-inheritance:
 
+synthetics\_test\_call\_type
+----------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_test_call_type
+   :members:
+   :show-inheritance:
+
 synthetics\_test\_ci\_options
 -----------------------------
 
diff --git a/examples/v1/synthetics/CreateSyntheticsAPITest.py b/examples/v1/synthetics/CreateSyntheticsAPITest.py
@@ -4,7 +4,6 @@
 
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
-from datadog_api_client.v1.model.http_method import HTTPMethod
 from datadog_api_client.v1.model.synthetics_api_test import SyntheticsAPITest
 from datadog_api_client.v1.model.synthetics_api_test_config import SyntheticsAPITestConfig
 from datadog_api_client.v1.model.synthetics_api_test_type import SyntheticsAPITestType
@@ -33,7 +32,7 @@
             ),
         ],
         request=SyntheticsTestRequest(
-            method=HTTPMethod.GET,
+            method="GET",
             url="https://example.com",
         ),
     ),
diff --git a/examples/v1/synthetics/CreateSyntheticsAPITest_1279271422.py b/examples/v1/synthetics/CreateSyntheticsAPITest_1279271422.py
@@ -4,7 +4,6 @@
 
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
-from datadog_api_client.v1.model.http_method import HTTPMethod
 from datadog_api_client.v1.model.synthetics_api_step import SyntheticsAPIStep
 from datadog_api_client.v1.model.synthetics_api_step_subtype import SyntheticsAPIStepSubtype
 from datadog_api_client.v1.model.synthetics_api_test import SyntheticsAPITest
@@ -59,7 +58,7 @@
                 is_critical=True,
                 name="request is sent",
                 request=SyntheticsTestRequest(
-                    method=HTTPMethod.GET,
+                    method="GET",
                     timeout=10.0,
                     url="https://datadoghq.com",
                 ),
diff --git a/examples/v1/synthetics/CreateSyntheticsAPITest_1402674167.py b/examples/v1/synthetics/CreateSyntheticsAPITest_1402674167.py
@@ -4,7 +4,6 @@
 
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
-from datadog_api_client.v1.model.http_method import HTTPMethod
 from datadog_api_client.v1.model.synthetics_api_test import SyntheticsAPITest
 from datadog_api_client.v1.model.synthetics_api_test_config import SyntheticsAPITestConfig
 from datadog_api_client.v1.model.synthetics_api_test_type import SyntheticsAPITestType
@@ -30,7 +29,7 @@
             host="localhost",
             port=50051,
             service="Hello",
-            method=HTTPMethod.GET,
+            method="GET",
             message="",
             metadata=SyntheticsTestMetadata(),
         ),
diff --git a/examples/v1/synthetics/CreateSyntheticsAPITest_1487281163.py b/examples/v1/synthetics/CreateSyntheticsAPITest_1487281163.py
@@ -4,7 +4,6 @@
 
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
-from datadog_api_client.v1.model.http_method import HTTPMethod
 from datadog_api_client.v1.model.synthetics_api_test import SyntheticsAPITest
 from datadog_api_client.v1.model.synthetics_api_test_config import SyntheticsAPITestConfig
 from datadog_api_client.v1.model.synthetics_api_test_type import SyntheticsAPITestType
@@ -92,7 +91,7 @@
             headers=SyntheticsTestHeaders(
                 unique="examplecreateanapihttptestreturnsokreturnsthecreatedtestdetailsresponse",
             ),
-            method=HTTPMethod.GET,
+            method="GET",
             timeout=10.0,
             url="https://datadoghq.com",
             proxy=SyntheticsTestRequestProxy(
diff --git a/examples/v1/synthetics/CreateSyntheticsAPITest_960766374.py b/examples/v1/synthetics/CreateSyntheticsAPITest_960766374.py
@@ -4,7 +4,6 @@
 
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
-from datadog_api_client.v1.model.http_method import HTTPMethod
 from datadog_api_client.v1.model.synthetics_api_test import SyntheticsAPITest
 from datadog_api_client.v1.model.synthetics_api_test_config import SyntheticsAPITestConfig
 from datadog_api_client.v1.model.synthetics_api_test_type import SyntheticsAPITestType
@@ -92,7 +91,7 @@
             headers=SyntheticsTestHeaders(
                 unique="examplecreateanapihttpwithoauthroptestreturnsokreturnsthecreatedtestdetailsresponse",
             ),
-            method=HTTPMethod.GET,
+            method="GET",
             timeout=10.0,
             url="https://datadoghq.com",
             proxy=SyntheticsTestRequestProxy(
diff --git a/examples/v1/synthetics/CreateSyntheticsBrowserTest.py b/examples/v1/synthetics/CreateSyntheticsBrowserTest.py
@@ -4,7 +4,6 @@
 
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
-from datadog_api_client.v1.model.http_method import HTTPMethod
 from datadog_api_client.v1.model.synthetics_browser_test import SyntheticsBrowserTest
 from datadog_api_client.v1.model.synthetics_browser_test_config import SyntheticsBrowserTestConfig
 from datadog_api_client.v1.model.synthetics_browser_test_type import SyntheticsBrowserTestType
@@ -29,7 +28,7 @@
             ),
         ],
         request=SyntheticsTestRequest(
-            method=HTTPMethod.GET,
+            method="GET",
             url="https://datadoghq.com",
         ),
         set_cookie="name:test",
diff --git a/examples/v1/synthetics/CreateSyntheticsBrowserTest_2932742688.py b/examples/v1/synthetics/CreateSyntheticsBrowserTest_2932742688.py
@@ -4,7 +4,6 @@
 
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
-from datadog_api_client.v1.model.http_method import HTTPMethod
 from datadog_api_client.v1.model.synthetics_browser_test import SyntheticsBrowserTest
 from datadog_api_client.v1.model.synthetics_browser_test_config import SyntheticsBrowserTestConfig
 from datadog_api_client.v1.model.synthetics_browser_test_rum_settings import SyntheticsBrowserTestRumSettings
@@ -32,7 +31,7 @@
             ),
         ],
         request=SyntheticsTestRequest(
-            method=HTTPMethod.GET,
+            method="GET",
             url="https://datadoghq.com",
             certificate_domains=[
                 "https://datadoghq.com",
diff --git a/examples/v1/synthetics/UpdateAPITest.py b/examples/v1/synthetics/UpdateAPITest.py
@@ -5,7 +5,6 @@
 from os import environ
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
-from datadog_api_client.v1.model.http_method import HTTPMethod
 from datadog_api_client.v1.model.synthetics_api_test import SyntheticsAPITest
 from datadog_api_client.v1.model.synthetics_api_test_config import SyntheticsAPITestConfig
 from datadog_api_client.v1.model.synthetics_api_test_type import SyntheticsAPITestType
@@ -77,7 +76,7 @@
             headers=SyntheticsTestHeaders(
                 unique="exampleeditanapitestreturnsokresponse",
             ),
-            method=HTTPMethod.GET,
+            method="GET",
             timeout=10.0,
             url="https://datadoghq.com",
         ),
diff --git a/examples/v1/synthetics/UpdateBrowserTest.py b/examples/v1/synthetics/UpdateBrowserTest.py
@@ -4,7 +4,6 @@
 
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
-from datadog_api_client.v1.model.http_method import HTTPMethod
 from datadog_api_client.v1.model.synthetics_basic_auth_web import SyntheticsBasicAuthWeb
 from datadog_api_client.v1.model.synthetics_basic_auth_web_type import SyntheticsBasicAuthWebType
 from datadog_api_client.v1.model.synthetics_browser_test import SyntheticsBrowserTest
@@ -19,6 +18,7 @@
 from datadog_api_client.v1.model.synthetics_restricted_roles import SyntheticsRestrictedRoles
 from datadog_api_client.v1.model.synthetics_step import SyntheticsStep
 from datadog_api_client.v1.model.synthetics_step_type import SyntheticsStepType
+from datadog_api_client.v1.model.synthetics_test_call_type import SyntheticsTestCallType
 from datadog_api_client.v1.model.synthetics_test_ci_options import SyntheticsTestCiOptions
 from datadog_api_client.v1.model.synthetics_test_execution_rule import SyntheticsTestExecutionRule
 from datadog_api_client.v1.model.synthetics_test_options import SyntheticsTestOptions
@@ -47,15 +47,16 @@
                 username="my_username",
             ),
             body_type=SyntheticsTestRequestBodyType.TEXT_PLAIN,
+            call_type=SyntheticsTestCallType.UNARY,
             certificate=SyntheticsTestRequestCertificate(
                 cert=SyntheticsTestRequestCertificateItem(),
                 key=SyntheticsTestRequestCertificateItem(),
             ),
             certificate_domains=[],
-            method=HTTPMethod.GET,
             proxy=SyntheticsTestRequestProxy(
                 url="https://example.com",
             ),
+            service="Greeter",
             url="https://example.com",
         ),
         variables=[
diff --git a/src/datadog_api_client/v1/model/http_method.py b/src/datadog_api_client/v1/model/http_method.py
diff --git a/src/datadog_api_client/v1/model/synthetics_test_call_type.py b/src/datadog_api_client/v1/model/synthetics_test_call_type.py
@@ -0,0 +1,38 @@
+# 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 SyntheticsTestCallType(ModelSimple):
+    """
+    The type of gRPC call to perform.
+
+    :param value: Must be one of ["healthcheck", "unary"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "healthcheck",
+        "unary",
+    }
+    HEALTHCHECK: ClassVar["SyntheticsTestCallType"]
+    UNARY: ClassVar["SyntheticsTestCallType"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+SyntheticsTestCallType.HEALTHCHECK = SyntheticsTestCallType("healthcheck")
+SyntheticsTestCallType.UNARY = SyntheticsTestCallType("unary")
diff --git a/src/datadog_api_client/v1/model/synthetics_test_request.py b/src/datadog_api_client/v1/model/synthetics_test_request.py
diff --git a/src/datadog_api_client/v1/models/__init__.py b/src/datadog_api_client/v1/models/__init__.py
diff --git a/tests/v1/features/synthetics.feature b/tests/v1/features/synthetics.feature

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": "2022-12-08 13:18:32.017696",`
`8`		`- "spec_repo_commit": "65b2053a"`
	`7`	`+ "regenerated": "2022-12-09 09:29:11.062861",`
	`8`	`+ "spec_repo_commit": "68c90324"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.4",`
`12`		`- "regenerated": "2022-12-08 13:18:32.032677",`
`13`		`- "spec_repo_commit": "65b2053a"`
	`12`	`+ "regenerated": "2022-12-09 09:29:11.074112",`
	`13`	`+ "spec_repo_commit": "68c90324"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`