Add endpoint to get and set on demand concurrency cap for Synthetics (#1341)

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.4",
-            "regenerated": "2023-02-16 09:01:15.697580",
-            "spec_repo_commit": "4982e03d"
+            "regenerated": "2023-02-17 16:19:14.693597",
+            "spec_repo_commit": "a05a9d36"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-02-16 09:01:15.714720",
-            "spec_repo_commit": "4982e03d"
+            "regenerated": "2023-02-17 16:19:14.705186",
+            "spec_repo_commit": "a05a9d36"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -7542,6 +7542,26 @@ components:
       - id
       - type
       type: object
+    OnDemandConcurrencyCap:
+      description: On-demand concurrency cap.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/OnDemandConcurrencyCapAttributes'
+      type: object
+    OnDemandConcurrencyCapAttributes:
+      description: On-demand concurrency cap attributes.
+      properties:
+        on_demand_concurrency_cap:
+          description: Value of the on-demand concurrency cap.
+          format: double
+          type: number
+      type: object
+    OnDemandConcurrencyCapResponse:
+      description: On-demand concurrency cap response.
+      properties:
+        data:
+          $ref: '#/components/schemas/OnDemandConcurrencyCap'
+      type: object
     OpsgenieServiceCreateAttributes:
       description: The Opsgenie service attributes for a create request.
       properties:
@@ -19685,6 +19705,45 @@ paths:
       x-unstable: '**Note**: This endpoint is in public beta.
 
         If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+  /api/v2/synthetics/settings/on_demand_concurrency_cap:
+    get:
+      description: Get the on-demand concurrency cap.
+      operationId: GetOnDemandConcurrencyCap
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/OnDemandConcurrencyCapResponse'
+          description: OK
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Get the on-demand concurrency cap
+      tags:
+      - Synthetics
+    post:
+      description: Save new value for on-demand concurrency cap.
+      operationId: SetOnDemandConcurrencyCap
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/OnDemandConcurrencyCapAttributes'
+        description: .
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/OnDemandConcurrencyCapResponse'
+          description: OK
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Save new value for on-demand concurrency cap
+      tags:
+      - Synthetics
+      x-codegen-request-body-name: body
   /api/v2/teams:
     get:
       description: Get all incident teams for the requesting user's organization.
@@ -20963,6 +21022,13 @@ tags:
   externalDocs:
     url: https://docs.datadoghq.com/tracing/service_catalog/
   name: Service Definition
+- description: "Datadog Synthetics uses simulated user requests and browser rendering
+    to help you ensure uptime,\nidentify regional issues, and track your application
+    performance. Datadog Synthetics tests come in\ntwo different flavors, [API tests](https://docs.datadoghq.com/synthetics/api_tests/)\nand
+    [browser tests](https://docs.datadoghq.com/synthetics/browser_tests). You can
+    use Datadog\u2019s API to\nmanage both test types programmatically.\n\nFor more
+    information about Synthetics, see the [Synthetics overview](https://docs.datadoghq.com/synthetics/)."
+  name: Synthetics
 - description: 'The usage metering API allows you to get hourly, daily, and
 
     monthly usage across multiple facets of Datadog.

docs/datadog_api_client.v2.api.rst

@@ -204,6 +204,13 @@ service\_definition\_api
    :members:
    :show-inheritance:
 
+synthetics\_api
+---------------
+
+.. automodule:: datadog_api_client.v2.api.synthetics_api
+   :members:
+   :show-inheritance:
+
 usage\_metering\_api
 --------------------
 

docs/datadog_api_client.v2.model.rst

@@ -3347,6 +3347,27 @@ nullable\_relationship\_to\_user\_data
    :members:
    :show-inheritance:
 
+on\_demand\_concurrency\_cap
+----------------------------
+
+.. automodule:: datadog_api_client.v2.model.on_demand_concurrency_cap
+   :members:
+   :show-inheritance:
+
+on\_demand\_concurrency\_cap\_attributes
+----------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.on_demand_concurrency_cap_attributes
+   :members:
+   :show-inheritance:
+
+on\_demand\_concurrency\_cap\_response
+--------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.on_demand_concurrency_cap_response
+   :members:
+   :show-inheritance:
+
 opsgenie\_service\_create\_attributes
 -------------------------------------
 

examples/v2/synthetics/GetOnDemandConcurrencyCap.py

@@ -0,0 +1,13 @@
+"""
+Get the on-demand concurrency cap returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = SyntheticsApi(api_client)
+    response = api_instance.get_on_demand_concurrency_cap()
+
+    print(response)

examples/v2/synthetics/GetOnDemandConcurrencyCap_2633566918.py

@@ -0,0 +1,13 @@
+"""
+Get on demand concurrency cap
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = SyntheticsApi(api_client)
+    response = api_instance.get_on_demand_concurrency_cap()
+
+    print(response)

examples/v2/synthetics/SetOnDemandConcurrencyCap.py

@@ -0,0 +1,16 @@
+"""
+Save new value for on-demand concurrency cap returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
+from datadog_api_client.v2.model.on_demand_concurrency_cap_attributes import OnDemandConcurrencyCapAttributes
+
+body = OnDemandConcurrencyCapAttributes()
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = SyntheticsApi(api_client)
+    response = api_instance.set_on_demand_concurrency_cap(body=body)
+
+    print(response)

examples/v2/synthetics/SetOnDemandConcurrencyCap_2850884405.py

@@ -0,0 +1,18 @@
+"""
+Save on demand concurrency cap
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
+from datadog_api_client.v2.model.on_demand_concurrency_cap_attributes import OnDemandConcurrencyCapAttributes
+
+body = OnDemandConcurrencyCapAttributes(
+    on_demand_concurrency_cap=20.0,
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = SyntheticsApi(api_client)
+    response = api_instance.set_on_demand_concurrency_cap(body=body)
+
+    print(response)

src/datadog_api_client/v2/api/synthetics_api.py

@@ -0,0 +1,96 @@
+# 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 typing import Any, Dict
+
+from datadog_api_client.api_client import ApiClient, Endpoint as _Endpoint
+from datadog_api_client.configuration import Configuration
+from datadog_api_client.v2.model.on_demand_concurrency_cap_response import OnDemandConcurrencyCapResponse
+from datadog_api_client.v2.model.on_demand_concurrency_cap_attributes import OnDemandConcurrencyCapAttributes
+
+
+class SyntheticsApi:
+    """
+    Datadog Synthetics uses simulated user requests and browser rendering to help you ensure uptime,
+    identify regional issues, and track your application performance. Datadog Synthetics tests come in
+    two different flavors, `API tests <https://docs.datadoghq.com/synthetics/api_tests/>`_
+    and `browser tests <https://docs.datadoghq.com/synthetics/browser_tests>`_. You can use Datadog’s API to
+    manage both test types programmatically.
+
+    For more information about Synthetics, see the `Synthetics overview <https://docs.datadoghq.com/synthetics/>`_.
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient(Configuration())
+        self.api_client = api_client
+
+        self._get_on_demand_concurrency_cap_endpoint = _Endpoint(
+            settings={
+                "response_type": (OnDemandConcurrencyCapResponse,),
+                "auth": ["apiKeyAuth", "appKeyAuth"],
+                "endpoint_path": "/api/v2/synthetics/settings/on_demand_concurrency_cap",
+                "operation_id": "get_on_demand_concurrency_cap",
+                "http_method": "GET",
+                "version": "v2",
+                "servers": None,
+            },
+            params_map={},
+            headers_map={
+                "accept": ["application/json"],
+                "content_type": [],
+            },
+            api_client=api_client,
+        )
+
+        self._set_on_demand_concurrency_cap_endpoint = _Endpoint(
+            settings={
+                "response_type": (OnDemandConcurrencyCapResponse,),
+                "auth": ["apiKeyAuth", "appKeyAuth"],
+                "endpoint_path": "/api/v2/synthetics/settings/on_demand_concurrency_cap",
+                "operation_id": "set_on_demand_concurrency_cap",
+                "http_method": "POST",
+                "version": "v2",
+                "servers": None,
+            },
+            params_map={
+                "body": {
+                    "required": True,
+                    "openapi_types": (OnDemandConcurrencyCapAttributes,),
+                    "location": "body",
+                },
+            },
+            headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
+            api_client=api_client,
+        )
+
+    def get_on_demand_concurrency_cap(
+        self,
+    ) -> OnDemandConcurrencyCapResponse:
+        """Get the on-demand concurrency cap.
+
+        Get the on-demand concurrency cap.
+
+        :rtype: OnDemandConcurrencyCapResponse
+        """
+        kwargs: Dict[str, Any] = {}
+        return self._get_on_demand_concurrency_cap_endpoint.call_with_http_info(**kwargs)
+
+    def set_on_demand_concurrency_cap(
+        self,
+        body: OnDemandConcurrencyCapAttributes,
+    ) -> OnDemandConcurrencyCapResponse:
+        """Save new value for on-demand concurrency cap.
+
+        Save new value for on-demand concurrency cap.
+
+        :param body: .
+        :type body: OnDemandConcurrencyCapAttributes
+        :rtype: OnDemandConcurrencyCapResponse
+        """
+        kwargs: Dict[str, Any] = {}
+        kwargs["body"] = body
+
+        return self._set_on_demand_concurrency_cap_endpoint.call_with_http_info(**kwargs)

src/datadog_api_client/v2/apis/__init__.py

@@ -27,5 +27,6 @@
 from datadog_api_client.v2.api.sensitive_data_scanner_api import SensitiveDataScannerApi
 from datadog_api_client.v2.api.service_accounts_api import ServiceAccountsApi
 from datadog_api_client.v2.api.service_definition_api import ServiceDefinitionApi
+from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
 from datadog_api_client.v2.api.usage_metering_api import UsageMeteringApi
 from datadog_api_client.v2.api.users_api import UsersApi