Add restricted_roles to Synthetics tests and private locations

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.2",
-            "regenerated": "2022-04-06 13:53:31.412683",
-            "spec_repo_commit": "0c154010"
+            "regenerated": "2022-04-07 18:07:20.321699",
+            "spec_repo_commit": "5ed02dad"
         },
         "v2": {
             "apigentools_version": "1.6.2",
-            "regenerated": "2022-04-06 13:53:31.433241",
-            "spec_repo_commit": "0c154010"
+            "regenerated": "2022-04-07 18:07:20.339514",
+            "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:

cassettes/v1/Synthetics_2658572017/Create-a-private-location-returns-OK-response_3848195822/frozen.json

@@ -0,0 +1 @@
+"2022-04-07T08:48:04.711Z"

examples/v1/synthetics/CreateGlobalVariable.ts

@@ -10,7 +10,7 @@ const apiInstance = new v1.SyntheticsApi(configuration);
 const params: v1.SyntheticsApiCreateGlobalVariableRequest = {
   body: {
     attributes: {
-      restrictedRoles: [],
+      restrictedRoles: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
     },
     description: "Example description",
     name: "MY_VARIABLE",

examples/v1/synthetics/CreatePrivateLocation.ts

@@ -7,11 +7,18 @@ import { v1 } from "@datadog/datadog-api-client";
 const configuration = v1.createConfiguration();
 const apiInstance = new v1.SyntheticsApi(configuration);
 
+// there is a valid "role" in the system
+const ROLE_DATA_ID = process.env.ROLE_DATA_ID as string;
+
 const params: v1.SyntheticsApiCreatePrivateLocationRequest = {
   body: {
-    description: "Description of private location",
-    name: "New private location",
-    tags: ["team:front"],
+    description:
+      "Test Example-Create_a_private_location_returns_OK_response description",
+    metadata: {
+      restrictedRoles: [ROLE_DATA_ID],
+    },
+    name: "Example-Create_a_private_location_returns_OK_response",
+    tags: ["test:examplecreateaprivatelocationreturnsokresponse"],
   },
 };
 

examples/v1/synthetics/CreateSyntheticsAPITest.ts

@@ -28,6 +28,7 @@ const params: v1.SyntheticsApiCreateSyntheticsAPITestRequest = {
     options: {
       deviceIds: ["laptop_large"],
       monitorOptions: {},
+      restrictedRoles: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
       retry: {},
     },
     status: "live",

examples/v1/synthetics/EditGlobalVariable.ts

@@ -10,7 +10,7 @@ const apiInstance = new v1.SyntheticsApi(configuration);
 const params: v1.SyntheticsApiEditGlobalVariableRequest = {
   body: {
     attributes: {
-      restrictedRoles: [],
+      restrictedRoles: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
     },
     description: "Example description",
     name: "MY_VARIABLE",

examples/v1/synthetics/UpdateBrowserTest.ts

@@ -46,6 +46,7 @@ const params: v1.SyntheticsApiUpdateBrowserTestRequest = {
     options: {
       deviceIds: ["laptop_large"],
       monitorOptions: {},
+      restrictedRoles: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
       retry: {},
     },
     status: "live",

examples/v1/synthetics/UpdatePrivateLocation.ts

@@ -10,6 +10,9 @@ const apiInstance = new v1.SyntheticsApi(configuration);
 const params: v1.SyntheticsApiUpdatePrivateLocationRequest = {
   body: {
     description: "Description of private location",
+    metadata: {
+      restrictedRoles: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
+    },
     name: "New private location",
     tags: ["team:front"],
   },