Remove pagination parameter from CI visibility aggregate endpoints (#1196)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit d92e7722a63c · 2023-01-11T10:35:05.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-01-09 17:15:10.567902",
-            "spec_repo_commit": "9f8d1169"
+            "regenerated": "2023-01-11 09:53:51.235905",
+            "spec_repo_commit": "c22824fc"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-01-09 17:15:10.579860",
-            "spec_repo_commit": "9f8d1169"
+            "regenerated": "2023-01-11 09:53:51.251741",
+            "spec_repo_commit": "c22824fc"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml
@@ -1423,7 +1423,7 @@ components:
         links:
           $ref: '#/components/schemas/CIAppResponseLinks'
         meta:
-          $ref: '#/components/schemas/CIAppResponseMetadata'
+          $ref: '#/components/schemas/CIAppResponseMetadataWithPagination'
       type: object
     CIAppPipelinesAggregateRequest:
       description: The object sent with the request to retrieve aggregation buckets
@@ -1444,8 +1444,6 @@ components:
           type: array
         options:
           $ref: '#/components/schemas/CIAppQueryOptions'
-        page:
-          $ref: '#/components/schemas/CIAppQueryPageOptions'
       type: object
     CIAppPipelinesAggregationBucketsResponse:
       description: The query results.
@@ -1568,6 +1566,29 @@ components:
           type: string
       type: object
     CIAppResponseMetadata:
+      description: The metadata associated with a request.
+      properties:
+        elapsed:
+          description: The time elapsed in milliseconds.
+          example: 132
+          format: int64
+          type: integer
+        request_id:
+          description: The identifier of the request.
+          example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR
+          type: string
+        status:
+          $ref: '#/components/schemas/CIAppResponseStatus'
+        warnings:
+          description: 'A list of warnings (non-fatal errors) encountered. Partial
+            results may return if
+
+            warnings are present in the response.'
+          items:
+            $ref: '#/components/schemas/CIAppWarning'
+          type: array
+      type: object
+    CIAppResponseMetadataWithPagination:
       description: The metadata associated with a request.
       properties:
         elapsed:
@@ -1675,7 +1696,7 @@ components:
         links:
           $ref: '#/components/schemas/CIAppResponseLinks'
         meta:
-          $ref: '#/components/schemas/CIAppResponseMetadata'
+          $ref: '#/components/schemas/CIAppResponseMetadataWithPagination'
       type: object
     CIAppTestsAggregateRequest:
       description: The object sent with the request to retrieve aggregation buckets
@@ -1696,8 +1717,6 @@ components:
           type: array
         options:
           $ref: '#/components/schemas/CIAppQueryOptions'
-        page:
-          $ref: '#/components/schemas/CIAppQueryPageOptions'
       type: object
     CIAppTestsAggregationBucketsResponse:
       description: The query results.
diff --git a/cassettes/features/v2/ci_visibility_pipelines/Aggregate-pipelines-events-returns-OK-response.yml b/cassettes/features/v2/ci_visibility_pipelines/Aggregate-pipelines-events-returns-OK-response.yml
diff --git a/cassettes/features/v2/ci_visibility_tests/Aggregate-tests-events-returns-OK-response.yml b/cassettes/features/v2/ci_visibility_tests/Aggregate-tests-events-returns-OK-response.yml
diff --git a/examples/v2/ci-visibility-pipelines/AggregateCIAppPipelineEvents.rb b/examples/v2/ci-visibility-pipelines/AggregateCIAppPipelineEvents.rb
@@ -26,8 +26,5 @@
   options: DatadogAPIClient::V2::CIAppQueryOptions.new({
     timezone: "GMT",
   }),
-  page: DatadogAPIClient::V2::CIAppQueryPageOptions.new({
-    limit: 25,
-  }),
 })
 p api_instance.aggregate_ci_app_pipeline_events(body)
diff --git a/examples/v2/ci-visibility-tests/AggregateCIAppTestEvents.rb b/examples/v2/ci-visibility-tests/AggregateCIAppTestEvents.rb
@@ -29,8 +29,5 @@
   options: DatadogAPIClient::V2::CIAppQueryOptions.new({
     timezone: "GMT",
   }),
-  page: DatadogAPIClient::V2::CIAppQueryPageOptions.new({
-    limit: 25,
-  }),
 })
 p api_instance.aggregate_ci_app_test_events(body)
diff --git a/features/v2/ci_visibility_pipelines.feature b/features/v2/ci_visibility_pipelines.feature
@@ -10,14 +10,14 @@ Feature: CI Visibility Pipelines
   @generated @skip @team:Datadog/ci-app-backend @team:Datadog/integrations-tools-and-libraries
   Scenario: Aggregate pipelines events returns "Bad Request" response
     Given new "AggregateCIAppPipelineEvents" request
-    And body with value {"compute": [{"aggregation": "pc90", "interval": "5m", "metric": "@duration", "type": "total"}], "filter": {"from": "now-15m", "query": "@ci.provider.name:github AND @ci.status:error", "to": "now"}, "group_by": [{"facet": "@ci.status", "histogram": {"interval": 10, "max": 100, "min": 50}, "limit": 10, "sort": {"aggregation": "count", "order": "asc"}, "total": false}], "options": {"timezone": "GMT"}, "page": {"cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "limit": 25}}
+    And body with value {"compute": [{"aggregation": "pc90", "interval": "5m", "metric": "@duration", "type": "total"}], "filter": {"from": "now-15m", "query": "@ci.provider.name:github AND @ci.status:error", "to": "now"}, "group_by": [{"facet": "@ci.status", "histogram": {"interval": 10, "max": 100, "min": 50}, "limit": 10, "sort": {"aggregation": "count", "order": "asc"}, "total": false}], "options": {"timezone": "GMT"}}
     When the request is sent
     Then the response status is 400 Bad Request
 
   @team:Datadog/ci-app-backend @team:Datadog/integrations-tools-and-libraries
   Scenario: Aggregate pipelines events returns "OK" response
     Given new "AggregateCIAppPipelineEvents" request
-    And body with value {"compute": [{"aggregation": "pc90", "metric": "@duration", "type": "total"}], "filter": {"from": "now-15m", "query": "@ci.provider.name:(gitlab OR github)", "to": "now"}, "group_by": [{ "facet": "@ci.status", "limit": 10, "total": false}], "options": {"timezone": "GMT"}, "page": {"limit": 25}}
+    And body with value {"compute": [{"aggregation": "pc90", "metric": "@duration", "type": "total"}], "filter": {"from": "now-15m", "query": "@ci.provider.name:(gitlab OR github)", "to": "now"}, "group_by": [{ "facet": "@ci.status", "limit": 10, "total": false}], "options": {"timezone": "GMT"}}
     When the request is sent
     Then the response status is 200 OK
 
diff --git a/features/v2/ci_visibility_tests.feature b/features/v2/ci_visibility_tests.feature
@@ -10,14 +10,14 @@ Feature: CI Visibility Tests
   @generated @skip @team:Datadog/ci-app-backend @team:Datadog/integrations-tools-and-libraries
   Scenario: Aggregate tests events returns "Bad Request" response
     Given new "AggregateCIAppTestEvents" request
-    And body with value {"compute": [{"aggregation": "pc90", "interval": "5m", "metric": "@duration", "type": "total"}], "filter": {"from": "now-15m", "query": "@test.service:web-ui-tests AND @test.status:fail", "to": "now"}, "group_by": [{"facet": "@test.service", "histogram": {"interval": 10, "max": 100, "min": 50}, "limit": 10, "sort": {"aggregation": "count", "order": "asc"}, "total": false}], "options": {"timezone": "GMT"}, "page": {"cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "limit": 25}}
+    And body with value {"compute": [{"aggregation": "pc90", "interval": "5m", "metric": "@duration", "type": "total"}], "filter": {"from": "now-15m", "query": "@test.service:web-ui-tests AND @test.status:fail", "to": "now"}, "group_by": [{"facet": "@test.service", "histogram": {"interval": 10, "max": 100, "min": 50}, "limit": 10, "sort": {"aggregation": "count", "order": "asc"}, "total": false}], "options": {"timezone": "GMT"}}
     When the request is sent
     Then the response status is 400 Bad Request
 
   @team:Datadog/ci-app-backend @team:Datadog/integrations-tools-and-libraries
   Scenario: Aggregate tests events returns "OK" response
     Given new "AggregateCIAppTestEvents" request
-    And body with value {"compute": [{"aggregation": "count", "metric": "@test.is_flaky", "type": "total"}], "filter": {"from": "now-15m", "query": "@language:(python OR go)", "to": "now"}, "group_by": [{"facet": "@git.branch", "limit": 10, "sort": {"order": "asc"}, "total": false}], "options": {"timezone": "GMT"}, "page": {"limit": 25}}
+    And body with value {"compute": [{"aggregation": "count", "metric": "@test.is_flaky", "type": "total"}], "filter": {"from": "now-15m", "query": "@language:(python OR go)", "to": "now"}, "group_by": [{"facet": "@git.branch", "limit": 10, "sort": {"order": "asc"}, "total": false}], "options": {"timezone": "GMT"}}
     When the request is sent
     Then the response status is 200 OK
 
diff --git a/lib/datadog_api_client/inflector.rb b/lib/datadog_api_client/inflector.rb
@@ -842,6 +842,7 @@ def overrides
           "v2.ci_app_query_page_options" => "CIAppQueryPageOptions",
           "v2.ci_app_response_links" => "CIAppResponseLinks",
           "v2.ci_app_response_metadata" => "CIAppResponseMetadata",
+          "v2.ci_app_response_metadata_with_pagination" => "CIAppResponseMetadataWithPagination",
           "v2.ci_app_response_page" => "CIAppResponsePage",
           "v2.ci_app_response_status" => "CIAppResponseStatus",
           "v2.ci_app_sort" => "CIAppSort",
diff --git a/lib/datadog_api_client/v2/models/ci_app_pipeline_events_response.rb b/lib/datadog_api_client/v2/models/ci_app_pipeline_events_response.rb
@@ -50,7 +50,7 @@ def self.openapi_types
       {
         :'data' => :'Array<CIAppPipelineEvent>',
         :'links' => :'CIAppResponseLinks',
-        :'meta' => :'CIAppResponseMetadata'
+        :'meta' => :'CIAppResponseMetadataWithPagination'
       }
     end
 
diff --git a/lib/datadog_api_client/v2/models/ci_app_pipelines_aggregate_request.rb b/lib/datadog_api_client/v2/models/ci_app_pipelines_aggregate_request.rb
@@ -38,18 +38,14 @@ class CIAppPipelinesAggregateRequest
     # Only supply timezone or time offset, not both. Otherwise, the query fails.
     attr_accessor :options
 
-    # Paging attributes for listing events.
-    attr_accessor :page
-
     # Attribute mapping from ruby-style variable name to JSON key.
     # @!visibility private
     def self.attribute_map
       {
         :'compute' => :'compute',
         :'filter' => :'filter',
         :'group_by' => :'group_by',
-        :'options' => :'options',
-        :'page' => :'page'
+        :'options' => :'options'
       }
     end
 
@@ -60,8 +56,7 @@ def self.openapi_types
         :'compute' => :'Array<CIAppCompute>',
         :'filter' => :'CIAppPipelinesQueryFilter',
         :'group_by' => :'Array<CIAppPipelinesGroupBy>',
-        :'options' => :'CIAppQueryOptions',
-        :'page' => :'CIAppQueryPageOptions'
+        :'options' => :'CIAppQueryOptions'
       }
     end
 
@@ -100,10 +95,6 @@ def initialize(attributes = {})
       if attributes.key?(:'options')
         self.options = attributes[:'options']
       end
-
-      if attributes.key?(:'page')
-        self.page = attributes[:'page']
-      end
     end
 
     # Check to see if the all the properties in the model are valid
@@ -122,15 +113,14 @@ def ==(o)
           compute == o.compute &&
           filter == o.filter &&
           group_by == o.group_by &&
-          options == o.options &&
-          page == o.page
+          options == o.options
     end
 
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [compute, filter, group_by, options, page].hash
+      [compute, filter, group_by, options].hash
     end
   end
 end
diff --git a/lib/datadog_api_client/v2/models/ci_app_response_metadata.rb b/lib/datadog_api_client/v2/models/ci_app_response_metadata.rb
@@ -28,9 +28,6 @@ class CIAppResponseMetadata
     # The time elapsed in milliseconds.
     attr_accessor :elapsed
 
-    # Paging attributes.
-    attr_accessor :page
-
     # The identifier of the request.
     attr_accessor :request_id
 
@@ -46,7 +43,6 @@ class CIAppResponseMetadata
     def self.attribute_map
       {
         :'elapsed' => :'elapsed',
-        :'page' => :'page',
         :'request_id' => :'request_id',
         :'status' => :'status',
         :'warnings' => :'warnings'
@@ -58,7 +54,6 @@ def self.attribute_map
     def self.openapi_types
       {
         :'elapsed' => :'Integer',
-        :'page' => :'CIAppResponsePage',
         :'request_id' => :'String',
         :'status' => :'CIAppResponseStatus',
         :'warnings' => :'Array<CIAppWarning>'
@@ -85,10 +80,6 @@ def initialize(attributes = {})
         self.elapsed = attributes[:'elapsed']
       end
 
-      if attributes.key?(:'page')
-        self.page = attributes[:'page']
-      end
-
       if attributes.key?(:'request_id')
         self.request_id = attributes[:'request_id']
       end
@@ -118,7 +109,6 @@ def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
           elapsed == o.elapsed &&
-          page == o.page &&
           request_id == o.request_id &&
           status == o.status &&
           warnings == o.warnings
@@ -128,7 +118,7 @@ def ==(o)
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [elapsed, page, request_id, status, warnings].hash
+      [elapsed, request_id, status, warnings].hash
     end
   end
 end
diff --git a/lib/datadog_api_client/v2/models/ci_app_response_metadata_with_pagination.rb b/lib/datadog_api_client/v2/models/ci_app_response_metadata_with_pagination.rb
diff --git a/lib/datadog_api_client/v2/models/ci_app_test_events_response.rb b/lib/datadog_api_client/v2/models/ci_app_test_events_response.rb
diff --git a/lib/datadog_api_client/v2/models/ci_app_tests_aggregate_request.rb b/lib/datadog_api_client/v2/models/ci_app_tests_aggregate_request.rb

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.4",`
`7`		`- "regenerated": "2023-01-09 17:15:10.567902",`
`8`		`- "spec_repo_commit": "9f8d1169"`
	`7`	`+ "regenerated": "2023-01-11 09:53:51.235905",`
	`8`	`+ "spec_repo_commit": "c22824fc"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.4",`
`12`		`- "regenerated": "2023-01-09 17:15:10.579860",`
`13`		`- "spec_repo_commit": "9f8d1169"`
	`12`	`+ "regenerated": "2023-01-11 09:53:51.251741",`
	`13`	`+ "spec_repo_commit": "c22824fc"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ def self.openapi_types`
`50`	`50`	`{`
`51`	`51`	`:'data' => :'Array<CIAppPipelineEvent>',`
`52`	`52`	`:'links' => :'CIAppResponseLinks',`
`53`		`- :'meta' => :'CIAppResponseMetadata'`
	`53`	`+ :'meta' => :'CIAppResponseMetadataWithPagination'`
`54`	`54`	`}`
`55`	`55`	`end`
`56`	`56`