Regenerate client from commit 5ed02dad of spec repo (#941)

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.2",
-            "regenerated": "2022-04-06 13:53:30.372196",
-            "spec_repo_commit": "0c154010"
+            "regenerated": "2022-04-07 18:07:23.251818",
+            "spec_repo_commit": "5ed02dad"
         },
         "v2": {
             "apigentools_version": "1.6.2",
-            "regenerated": "2022-04-06 13:53:30.384412",
-            "spec_repo_commit": "0c154010"
+            "regenerated": "2022-04-07 18:07:23.263542",
+            "spec_repo_commit": "5ed02dad"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -11257,12 +11257,7 @@ components:
       description: Attributes of the global variable.
       properties:
         restricted_roles:
-          description: List of role identifiers that can be pulled from the Roles
-            API.
-          items:
-            description: UUID for a role.
-            type: string
-          type: array
+          $ref: '#/components/schemas/SyntheticsRestrictedRoles'
       type: object
     SyntheticsGlobalVariableParseTestOptions:
       description: Parser options to use for retrieving a Synthetics global variable
@@ -11407,6 +11402,8 @@ components:
           description: Unique identifier of the private location.
           readOnly: true
           type: string
+        metadata:
+          $ref: '#/components/schemas/SyntheticsPrivateLocationMetadata'
         name:
           description: Name of the private location.
           example: New private location
@@ -11450,6 +11447,12 @@ components:
           description: Public key for result encryption.
           type: string
       type: object
+    SyntheticsPrivateLocationMetadata:
+      description: Object containing metadata about the private location.
+      properties:
+        restricted_roles:
+          $ref: '#/components/schemas/SyntheticsRestrictedRoles'
+      type: object
     SyntheticsPrivateLocationSecrets:
       description: Secrets for the private location. Only present in the response
         when creating the private location.
@@ -11480,6 +11483,16 @@ components:
           readOnly: true
           type: string
       type: object
+    SyntheticsRestrictedRoles:
+      description: A list of role identifiers that can be pulled from the Roles API,
+        for restricting read and write access.
+      example:
+      - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+      items:
+        description: UUID for a role.
+        example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+        type: string
+      type: array
     SyntheticsSSLCertificate:
       description: Object describing the SSL certificate used for a Synthetic test.
       properties:
@@ -11933,6 +11946,8 @@ components:
         noScreenshot:
           description: Prevents saving screenshots of the steps.
           type: boolean
+        restricted_roles:
+          $ref: '#/components/schemas/SyntheticsRestrictedRoles'
         retry:
           $ref: '#/components/schemas/SyntheticsTestOptionsRetry'
         tick_every:
@@ -24005,7 +24020,7 @@ paths:
         operationId: DeletePrivateLocation
         parameters:
         - name: location_id
-          source: private_location
+          source: private_location.id
         type: unsafe
   /api/v1/synthetics/private-locations/{location_id}:
     delete:

docs/datadog_api_client.v1.model.rst

@@ -3977,6 +3977,14 @@ synthetics\_private\_location\_creation\_response\_result\_encryption
    :undoc-members:
    :show-inheritance:
 
+synthetics\_private\_location\_metadata
+---------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_private_location_metadata
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 synthetics\_private\_location\_secrets
 --------------------------------------
 
@@ -4001,6 +4009,14 @@ synthetics\_private\_location\_secrets\_config\_decryption
    :undoc-members:
    :show-inheritance:
 
+synthetics\_restricted\_roles
+-----------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_restricted_roles
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 synthetics\_ssl\_certificate
 ----------------------------
 

examples/v1/synthetics/CreateGlobalVariable.py

@@ -14,10 +14,13 @@
 )
 from datadog_api_client.v1.model.synthetics_global_variable_parser_type import SyntheticsGlobalVariableParserType
 from datadog_api_client.v1.model.synthetics_global_variable_value import SyntheticsGlobalVariableValue
+from datadog_api_client.v1.model.synthetics_restricted_roles import SyntheticsRestrictedRoles
 from datadog_api_client.v1.model.synthetics_variable_parser import SyntheticsVariableParser
 
 body = SyntheticsGlobalVariable(
-    attributes=SyntheticsGlobalVariableAttributes(restricted_roles=[]),
+    attributes=SyntheticsGlobalVariableAttributes(
+        restricted_roles=SyntheticsRestrictedRoles(["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"])
+    ),
     description="Example description",
     name="MY_VARIABLE",
     parse_test_options=SyntheticsGlobalVariableParseTestOptions(

examples/v1/synthetics/CreatePrivateLocation.py

@@ -2,12 +2,21 @@
 Create a private location returns "OK" response
 """
 
+from os import environ
 from datadog_api_client.v1 import ApiClient, Configuration
 from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
 from datadog_api_client.v1.model.synthetics_private_location import SyntheticsPrivateLocation
+from datadog_api_client.v1.model.synthetics_private_location_metadata import SyntheticsPrivateLocationMetadata
+from datadog_api_client.v1.model.synthetics_restricted_roles import SyntheticsRestrictedRoles
+
+# there is a valid "role" in the system
+ROLE_DATA_ID = environ["ROLE_DATA_ID"]
 
 body = SyntheticsPrivateLocation(
-    description="Description of private location", name="New private location", tags=["team:front"]
+    description="Test Example-Create_a_private_location_returns_OK_response description",
+    metadata=SyntheticsPrivateLocationMetadata(restricted_roles=SyntheticsRestrictedRoles([ROLE_DATA_ID])),
+    name="Example-Create_a_private_location_returns_OK_response",
+    tags=["test:examplecreateaprivatelocationreturnsokresponse"],
 )
 
 configuration = Configuration()

examples/v1/synthetics/CreateSyntheticsAPITest.py

@@ -12,6 +12,7 @@
 from datadog_api_client.v1.model.synthetics_assertion_target import SyntheticsAssertionTarget
 from datadog_api_client.v1.model.synthetics_assertion_type import SyntheticsAssertionType
 from datadog_api_client.v1.model.synthetics_device_id import SyntheticsDeviceID
+from datadog_api_client.v1.model.synthetics_restricted_roles import SyntheticsRestrictedRoles
 from datadog_api_client.v1.model.synthetics_test_details_sub_type import SyntheticsTestDetailsSubType
 from datadog_api_client.v1.model.synthetics_test_options import SyntheticsTestOptions
 from datadog_api_client.v1.model.synthetics_test_options_monitor_options import SyntheticsTestOptionsMonitorOptions
@@ -36,6 +37,7 @@
     options=SyntheticsTestOptions(
         device_ids=[SyntheticsDeviceID("laptop_large")],
         monitor_options=SyntheticsTestOptionsMonitorOptions(),
+        restricted_roles=SyntheticsRestrictedRoles(["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]),
         retry=SyntheticsTestOptionsRetry(),
     ),
     status=SyntheticsTestPauseStatus("live"),

examples/v1/synthetics/EditGlobalVariable.py

@@ -14,10 +14,13 @@
 )
 from datadog_api_client.v1.model.synthetics_global_variable_parser_type import SyntheticsGlobalVariableParserType
 from datadog_api_client.v1.model.synthetics_global_variable_value import SyntheticsGlobalVariableValue
+from datadog_api_client.v1.model.synthetics_restricted_roles import SyntheticsRestrictedRoles
 from datadog_api_client.v1.model.synthetics_variable_parser import SyntheticsVariableParser
 
 body = SyntheticsGlobalVariable(
-    attributes=SyntheticsGlobalVariableAttributes(restricted_roles=[]),
+    attributes=SyntheticsGlobalVariableAttributes(
+        restricted_roles=SyntheticsRestrictedRoles(["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"])
+    ),
     description="Example description",
     name="MY_VARIABLE",
     parse_test_options=SyntheticsGlobalVariableParseTestOptions(

examples/v1/synthetics/UpdateBrowserTest.py

@@ -15,6 +15,7 @@
 from datadog_api_client.v1.model.synthetics_config_variable import SyntheticsConfigVariable
 from datadog_api_client.v1.model.synthetics_config_variable_type import SyntheticsConfigVariableType
 from datadog_api_client.v1.model.synthetics_device_id import SyntheticsDeviceID
+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_options import SyntheticsTestOptions
@@ -49,6 +50,7 @@
     options=SyntheticsTestOptions(
         device_ids=[SyntheticsDeviceID("laptop_large")],
         monitor_options=SyntheticsTestOptionsMonitorOptions(),
+        restricted_roles=SyntheticsRestrictedRoles(["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]),
         retry=SyntheticsTestOptionsRetry(),
     ),
     status=SyntheticsTestPauseStatus("live"),

examples/v1/synthetics/UpdatePrivateLocation.py

@@ -5,9 +5,16 @@
 from datadog_api_client.v1 import ApiClient, Configuration
 from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
 from datadog_api_client.v1.model.synthetics_private_location import SyntheticsPrivateLocation
+from datadog_api_client.v1.model.synthetics_private_location_metadata import SyntheticsPrivateLocationMetadata
+from datadog_api_client.v1.model.synthetics_restricted_roles import SyntheticsRestrictedRoles
 
 body = SyntheticsPrivateLocation(
-    description="Description of private location", name="New private location", tags=["team:front"]
+    description="Description of private location",
+    metadata=SyntheticsPrivateLocationMetadata(
+        restricted_roles=SyntheticsRestrictedRoles(["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"])
+    ),
+    name="New private location",
+    tags=["team:front"],
 )
 
 configuration = Configuration()