Add Beta Banner to Send Pipeline Events Endpoint (#1737)

Co-authored-by: ci.datadog-api-spec <[email protected]>
DataDog · Oct 27, 2023 · 45c4c4d · 45c4c4d
1 parent 859f8eb
commit 45c4c4d
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 9 deletions.
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-27 07:36:48.282560",
-            "spec_repo_commit": "2204d6df"
+            "regenerated": "2023-10-27 08:09:54.577931",
+            "spec_repo_commit": "86d56f2b"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-27 07:36:48.296883",
-            "spec_repo_commit": "2204d6df"
+            "regenerated": "2023-10-27 08:09:54.592108",
+            "spec_repo_commit": "86d56f2b"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml
@@ -19705,6 +19705,9 @@ paths:
       tags:
       - CI Visibility Pipelines
       x-codegen-request-body-name: body
+      x-unstable: '**Note:** This endpoint is in public beta.
+
+        If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
   /api/v2/ci/pipelines/analytics/aggregate:
     post:
       description: Use this API endpoint to aggregate CI Visibility pipeline events

diff --git a/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent.py b/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent.py
@@ -43,6 +43,7 @@
 )
 
 configuration = Configuration()
+configuration.unstable_operations["create_ci_app_pipeline_event"] = True
 with ApiClient(configuration) as api_client:
     api_instance = CIVisibilityPipelinesApi(api_client)
     response = api_instance.create_ci_app_pipeline_event(body=body)

diff --git a/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent_129899466.py b/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent_129899466.py
@@ -38,6 +38,7 @@
 )
 
 configuration = Configuration()
+configuration.unstable_operations["create_ci_app_pipeline_event"] = True
 with ApiClient(configuration) as api_client:
     api_instance = CIVisibilityPipelinesApi(api_client)
     response = api_instance.create_ci_app_pipeline_event(body=body)

diff --git a/src/datadog_api_client/configuration.py b/src/datadog_api_client/configuration.py
@@ -236,6 +236,7 @@ def __init__(
         # Keep track of unstable operations
         self.unstable_operations = _UnstableOperations(
             {
+                "v2.create_ci_app_pipeline_event": False,
                 "v2.list_container_images": False,
                 "v2.list_containers": False,
                 "v2.list_events": False,

diff --git a/tests/v2/features/ci_visibility_pipelines.feature b/tests/v2/features/ci_visibility_pipelines.feature
@@ -80,35 +80,40 @@ Feature: CI Visibility Pipelines
 
   @generated @skip @team:Datadog/ci-app-backend @team:Datadog/integrations-tools-and-libraries
   Scenario: Send pipeline event returns "Bad Request" response
-    Given new "CreateCIAppPipelineEvent" request
+    Given operation "CreateCIAppPipelineEvent" enabled
+    And new "CreateCIAppPipelineEvent" request
     And body with value {"data": {"attributes": {"resource": "Details TBD"}, "type": "cipipeline_resource_request"}}
     When the request is sent
     Then the response status is 400 Bad Request
 
   @generated @skip @team:Datadog/ci-app-backend @team:Datadog/integrations-tools-and-libraries
   Scenario: Send pipeline event returns "Payload Too Large" response
-    Given new "CreateCIAppPipelineEvent" request
+    Given operation "CreateCIAppPipelineEvent" enabled
+    And new "CreateCIAppPipelineEvent" request
     And body with value {"data": {"attributes": {"resource": "Details TBD"}, "type": "cipipeline_resource_request"}}
     When the request is sent
     Then the response status is 413 Payload Too Large
 
   @generated @skip @team:Datadog/ci-app-backend @team:Datadog/integrations-tools-and-libraries
   Scenario: Send pipeline event returns "Request Timeout" response
-    Given new "CreateCIAppPipelineEvent" request
+    Given operation "CreateCIAppPipelineEvent" enabled
+    And new "CreateCIAppPipelineEvent" request
     And body with value {"data": {"attributes": {"resource": "Details TBD"}, "type": "cipipeline_resource_request"}}
     When the request is sent
     Then the response status is 408 Request Timeout
 
   @team:Datadog/ci-app-backend @team:Datadog/integrations-tools-and-libraries
   Scenario: Send pipeline event returns "Request accepted for processing" response
-    Given new "CreateCIAppPipelineEvent" request
+    Given operation "CreateCIAppPipelineEvent" enabled
+    And new "CreateCIAppPipelineEvent" request
     And body with value {"data": {"attributes": {"resource": {"end": "{{ timeISO('now - 30s') }}", "level": "pipeline", "name": "Deploy to AWS", "partial_retry": false, "start": "{{ timeISO('now - 120s') }}", "status": "success", "unique_id": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", "url": "https://my-ci-provider.example/pipelines/my-pipeline/run/1","git":{"repository_url":"https://github.com/DataDog/datadog-agent","sha":"7f263865994b76066c4612fd1965215e7dcb4cd2","author_email":"[email protected]"}}}, "type": "cipipeline_resource_request"}}
     When the request is sent
     Then the response status is 202 Request accepted for processing
 
   @team:Datadog/ci-app-backend @team:Datadog/integrations-tools-and-libraries
   Scenario: Send pipeline job event returns "Request accepted for processing" response
-    Given new "CreateCIAppPipelineEvent" request
+    Given operation "CreateCIAppPipelineEvent" enabled
+    And new "CreateCIAppPipelineEvent" request
     And body with value {"data": {"attributes": {"resource": {"end": "{{ timeISO('now - 30s') }}", "level": "job", "name": "Build image", "start": "{{ timeISO('now - 120s') }}", "status": "error", "id": "cf9456de-8b9e-4c27-aa79-27b1e78c1a33", "pipeline_unique_id": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", "pipeline_name": "Deploy to AWS", "url": "https://my-ci-provider.example/jobs/my-jobs/run/1"}}, "type": "cipipeline_resource_request"}}
     When the request is sent
     Then the response status is 202 Request accepted for processing