Add examples for resources for Cloudflare (#2747)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
DataDog · Oct 31, 2024 · 7e1cfa4 · 7e1cfa4
1 parent b111c82
commit 7e1cfa4
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 14 deletions.
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-10-31 14:51:18.802907",
-            "spec_repo_commit": "e9cc5e6a"
+            "regenerated": "2024-10-31 15:33:09.790448",
+            "spec_repo_commit": "a7602fa1"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-10-31 14:51:18.821531",
-            "spec_repo_commit": "e9cc5e6a"
+            "regenerated": "2024-10-31 15:33:09.808736",
+            "spec_repo_commit": "a7602fa1"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml
@@ -4527,10 +4527,13 @@ components:
           example: test-name
           type: string
         resources:
-          description: An allowlist of resources to restrict pulling metrics for.
+          description: An allowlist of resources to restrict pulling metrics for including
+            `'web', 'dns', 'lb' (load balancer), 'worker'`.
           example:
           - web
           - dns
+          - lb
+          - worker
           items:
             type: string
           type: array
@@ -4575,10 +4578,13 @@ components:
           example: test-name
           type: string
         resources:
-          description: An allowlist of resources to restrict pulling metrics for.
+          description: An allowlist of resources to restrict pulling metrics for including
+            `'web', 'dns', 'lb' (load balancer), 'worker'`.
           example:
           - web
           - dns
+          - lb
+          - worker
           items:
             type: string
           type: array
@@ -4642,10 +4648,13 @@ components:
           description: The name of the Cloudflare account.
           type: string
         resources:
-          description: An allowlist of resources to restrict pulling metrics for.
+          description: An allowlist of resources to restrict pulling metrics for including
+            `'web', 'dns', 'lb' (load balancer), 'worker'`.
           example:
           - web
           - dns
+          - lb
+          - worker
           items:
             type: string
           type: array

diff --git a/api/datadogV2/model_cloudflare_account_create_request_attributes.go b/api/datadogV2/model_cloudflare_account_create_request_attributes.go
@@ -18,7 +18,7 @@ type CloudflareAccountCreateRequestAttributes struct {
 	Email *string `json:"email,omitempty"`
 	// The name of the Cloudflare account.
 	Name string `json:"name"`
-	// An allowlist of resources to restrict pulling metrics for.
+	// An allowlist of resources to restrict pulling metrics for including `'web', 'dns', 'lb' (load balancer), 'worker'`.
 	Resources []string `json:"resources,omitempty"`
 	// An allowlist of zones to restrict pulling metrics for.
 	Zones []string `json:"zones,omitempty"`

diff --git a/api/datadogV2/model_cloudflare_account_response_attributes.go b/api/datadogV2/model_cloudflare_account_response_attributes.go
@@ -16,7 +16,7 @@ type CloudflareAccountResponseAttributes struct {
 	Email *string `json:"email,omitempty"`
 	// The name of the Cloudflare account.
 	Name string `json:"name"`
-	// An allowlist of resources to restrict pulling metrics for.
+	// An allowlist of resources to restrict pulling metrics for including `'web', 'dns', 'lb' (load balancer), 'worker'`.
 	Resources []string `json:"resources,omitempty"`
 	// An allowlist of zones to restrict pulling metrics for.
 	Zones []string `json:"zones,omitempty"`

diff --git a/api/datadogV2/model_cloudflare_account_update_request_attributes.go b/api/datadogV2/model_cloudflare_account_update_request_attributes.go
@@ -18,7 +18,7 @@ type CloudflareAccountUpdateRequestAttributes struct {
 	Email *string `json:"email,omitempty"`
 	// The name of the Cloudflare account.
 	Name *string `json:"name,omitempty"`
-	// An allowlist of resources to restrict pulling metrics for.
+	// An allowlist of resources to restrict pulling metrics for including `'web', 'dns', 'lb' (load balancer), 'worker'`.
 	Resources []string `json:"resources,omitempty"`
 	// An allowlist of zones to restrict pulling metrics for.
 	Zones []string `json:"zones,omitempty"`

diff --git a/tests/scenarios/features/v2/cloudflare_integration.feature b/tests/scenarios/features/v2/cloudflare_integration.feature
@@ -13,7 +13,7 @@ Feature: Cloudflare Integration
   @generated @skip @team:DataDog/saas-integrations
   Scenario: Add Cloudflare account returns "Bad Request" response
     Given new "CreateCloudflareAccount" request
-    And body with value {"data": {"attributes": {"api_key": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3", "email": "test-email@example.com", "name": "test-name", "resources": ["web", "dns"], "zones": ["zone_id_1", "zone_id_2"]}, "type": "cloudflare-accounts"}}
+    And body with value {"data": {"attributes": {"api_key": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3", "email": "test-email@example.com", "name": "test-name", "resources": ["web", "dns", "lb", "worker"], "zones": ["zone_id_1", "zone_id_2"]}, "type": "cloudflare-accounts"}}
     When the request is sent
     Then the response status is 400 Bad Request
 
@@ -44,7 +44,7 @@ Feature: Cloudflare Integration
   @generated @skip @team:DataDog/saas-integrations
   Scenario: Add Cloudflare account returns "Not Found" response
     Given new "CreateCloudflareAccount" request
-    And body with value {"data": {"attributes": {"api_key": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3", "email": "test-email@example.com", "name": "test-name", "resources": ["web", "dns"], "zones": ["zone_id_1", "zone_id_2"]}, "type": "cloudflare-accounts"}}
+    And body with value {"data": {"attributes": {"api_key": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3", "email": "test-email@example.com", "name": "test-name", "resources": ["web", "dns", "lb", "worker"], "zones": ["zone_id_1", "zone_id_2"]}, "type": "cloudflare-accounts"}}
     When the request is sent
     Then the response status is 404 Not Found
 
@@ -118,7 +118,7 @@ Feature: Cloudflare Integration
   Scenario: Update Cloudflare account returns "Bad Request" response
     Given new "UpdateCloudflareAccount" request
     And request contains "account_id" parameter from "REPLACE.ME"
-    And body with value {"data": {"attributes": {"api_key": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3", "email": "test-email@example.com", "resources": ["web", "dns"], "zones": ["zone_id_1", "zone_id_2"]}, "type": "cloudflare-accounts"}}
+    And body with value {"data": {"attributes": {"api_key": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3", "email": "test-email@example.com", "resources": ["web", "dns", "lb", "worker"], "zones": ["zone_id_1", "zone_id_2"]}, "type": "cloudflare-accounts"}}
     When the request is sent
     Then the response status is 400 Bad Request
 
@@ -144,7 +144,7 @@ Feature: Cloudflare Integration
   Scenario: Update Cloudflare account returns "Not Found" response
     Given new "UpdateCloudflareAccount" request
     And request contains "account_id" parameter from "REPLACE.ME"
-    And body with value {"data": {"attributes": {"api_key": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3", "email": "test-email@example.com", "resources": ["web", "dns"], "zones": ["zone_id_1", "zone_id_2"]}, "type": "cloudflare-accounts"}}
+    And body with value {"data": {"attributes": {"api_key": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3", "email": "test-email@example.com", "resources": ["web", "dns", "lb", "worker"], "zones": ["zone_id_1", "zone_id_2"]}, "type": "cloudflare-accounts"}}
     When the request is sent
     Then the response status is 404 Not Found