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

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 61e9ce787a59 · 2023-01-11T10:35:40.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
Co-authored-by: api-clients-generation-pipeline[bot] &lt;54105614+api-clients-generation-pipeline[bot]@users.noreply.github.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:14.101086",
-            "spec_repo_commit": "9f8d1169"
+            "regenerated": "2023-01-11 09:53:49.785215",
+            "spec_repo_commit": "c22824fc"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-01-09 17:15:14.116260",
-            "spec_repo_commit": "9f8d1169"
+            "regenerated": "2023-01-11 09:53:49.795808",
+            "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/v2/CI-Visibility-Pipelines_2492627744/Aggregate-pipelines-events-returns-OK-response_454816794/recording.har b/cassettes/v2/CI-Visibility-Pipelines_2492627744/Aggregate-pipelines-events-returns-OK-response_454816794/recording.har
@@ -8,7 +8,7 @@
     },
     "entries": [
       {
-        "_id": "a2f719c1d23b81213c7185d0426ee0c9",
+        "_id": "8aca276f92104126d1965f116fa2418d",
         "_order": 0,
         "cache": {},
         "request": {
@@ -32,7 +32,7 @@
           "postData": {
             "mimeType": "application/json",
             "params": [],
-            "text": "{\"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}}"
+            "text": "{\"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\"}}"
           },
           "queryString": [],
           "url": "https://api.datadoghq.com/api/v2/ci/pipelines/analytics/aggregate"
diff --git a/cassettes/v2/CI-Visibility-Tests_768312914/Aggregate-tests-events-returns-OK-response_3931304892/recording.har b/cassettes/v2/CI-Visibility-Tests_768312914/Aggregate-tests-events-returns-OK-response_3931304892/recording.har
@@ -8,7 +8,7 @@
     },
     "entries": [
       {
-        "_id": "5b12751f40e7ea16c44e3175b516a9cc",
+        "_id": "272d6a089b991c8e2c3f91de054ff118",
         "_order": 0,
         "cache": {},
         "request": {
@@ -32,7 +32,7 @@
           "postData": {
             "mimeType": "application/json",
             "params": [],
-            "text": "{\"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}}"
+            "text": "{\"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\"}}"
           },
           "queryString": [],
           "url": "https://api.datadoghq.com/api/v2/ci/tests/analytics/aggregate"
diff --git a/examples/v2/ci-visibility-pipelines/AggregateCIAppPipelineEvents.ts b/examples/v2/ci-visibility-pipelines/AggregateCIAppPipelineEvents.ts
@@ -31,9 +31,6 @@ const params: v2.CIVisibilityPipelinesApiAggregateCIAppPipelineEventsRequest = {
     options: {
       timezone: "GMT",
     },
-    page: {
-      limit: 25,
-    },
   },
 };
 
diff --git a/examples/v2/ci-visibility-tests/AggregateCIAppTestEvents.ts b/examples/v2/ci-visibility-tests/AggregateCIAppTestEvents.ts
@@ -34,9 +34,6 @@ const params: v2.CIVisibilityTestsApiAggregateCIAppTestEventsRequest = {
     options: {
       timezone: "GMT",
     },
-    page: {
-      limit: 25,
-    },
   },
 };
 
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/packages/datadog-api-client-v2/index.ts b/packages/datadog-api-client-v2/index.ts
@@ -352,6 +352,7 @@ export { CIAppQueryOptions } from "./models/CIAppQueryOptions";
 export { CIAppQueryPageOptions } from "./models/CIAppQueryPageOptions";
 export { CIAppResponseLinks } from "./models/CIAppResponseLinks";
 export { CIAppResponseMetadata } from "./models/CIAppResponseMetadata";
+export { CIAppResponseMetadataWithPagination } from "./models/CIAppResponseMetadataWithPagination";
 export { CIAppResponsePage } from "./models/CIAppResponsePage";
 export { CIAppResponseStatus } from "./models/CIAppResponseStatus";
 export { CIAppSort } from "./models/CIAppSort";
diff --git a/packages/datadog-api-client-v2/models/CIAppPipelineEventsResponse.ts b/packages/datadog-api-client-v2/models/CIAppPipelineEventsResponse.ts
@@ -5,7 +5,7 @@
  */
 import { CIAppPipelineEvent } from "./CIAppPipelineEvent";
 import { CIAppResponseLinks } from "./CIAppResponseLinks";
-import { CIAppResponseMetadata } from "./CIAppResponseMetadata";
+import { CIAppResponseMetadataWithPagination } from "./CIAppResponseMetadataWithPagination";
 
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
@@ -24,7 +24,7 @@ export class CIAppPipelineEventsResponse {
   /**
    * The metadata associated with a request.
    */
-  "meta"?: CIAppResponseMetadata;
+  "meta"?: CIAppResponseMetadataWithPagination;
 
   /**
    * @ignore
@@ -45,7 +45,7 @@ export class CIAppPipelineEventsResponse {
     },
     meta: {
       baseName: "meta",
-      type: "CIAppResponseMetadata",
+      type: "CIAppResponseMetadataWithPagination",
     },
   };
 
diff --git a/packages/datadog-api-client-v2/models/CIAppPipelinesAggregateRequest.ts b/packages/datadog-api-client-v2/models/CIAppPipelinesAggregateRequest.ts
@@ -7,7 +7,6 @@ import { CIAppCompute } from "./CIAppCompute";
 import { CIAppPipelinesGroupBy } from "./CIAppPipelinesGroupBy";
 import { CIAppPipelinesQueryFilter } from "./CIAppPipelinesQueryFilter";
 import { CIAppQueryOptions } from "./CIAppQueryOptions";
-import { CIAppQueryPageOptions } from "./CIAppQueryPageOptions";
 
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
@@ -32,10 +31,6 @@ export class CIAppPipelinesAggregateRequest {
    * Only supply timezone or time offset, not both. Otherwise, the query fails.
    */
   "options"?: CIAppQueryOptions;
-  /**
-   * Paging attributes for listing events.
-   */
-  "page"?: CIAppQueryPageOptions;
 
   /**
    * @ignore
@@ -62,10 +57,6 @@ export class CIAppPipelinesAggregateRequest {
       baseName: "options",
       type: "CIAppQueryOptions",
     },
-    page: {
-      baseName: "page",
-      type: "CIAppQueryPageOptions",
-    },
   };
 
   /**
diff --git a/packages/datadog-api-client-v2/models/CIAppResponseMetadata.ts b/packages/datadog-api-client-v2/models/CIAppResponseMetadata.ts
@@ -3,7 +3,6 @@
  * This product includes software developed at Datadog (https://www.datadoghq.com/).
  * Copyright 2020-Present Datadog, Inc.
  */
-import { CIAppResponsePage } from "./CIAppResponsePage";
 import { CIAppResponseStatus } from "./CIAppResponseStatus";
 import { CIAppWarning } from "./CIAppWarning";
 
@@ -17,10 +16,6 @@ export class CIAppResponseMetadata {
    * The time elapsed in milliseconds.
    */
   "elapsed"?: number;
-  /**
-   * Paging attributes.
-   */
-  "page"?: CIAppResponsePage;
   /**
    * The identifier of the request.
    */
@@ -49,10 +44,6 @@ export class CIAppResponseMetadata {
       type: "number",
       format: "int64",
     },
-    page: {
-      baseName: "page",
-      type: "CIAppResponsePage",
-    },
     requestId: {
       baseName: "request_id",
       type: "string",
diff --git a/packages/datadog-api-client-v2/models/CIAppResponseMetadataWithPagination.ts b/packages/datadog-api-client-v2/models/CIAppResponseMetadataWithPagination.ts
@@ -0,0 +1,78 @@
+/**
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2020-Present Datadog, Inc.
+ */
+import { CIAppResponsePage } from "./CIAppResponsePage";
+import { CIAppResponseStatus } from "./CIAppResponseStatus";
+import { CIAppWarning } from "./CIAppWarning";
+
+import { AttributeTypeMap } from "../../datadog-api-client-common/util";
+
+/**
+ * The metadata associated with a request.
+ */
+export class CIAppResponseMetadataWithPagination {
+  /**
+   * The time elapsed in milliseconds.
+   */
+  "elapsed"?: number;
+  /**
+   * Paging attributes.
+   */
+  "page"?: CIAppResponsePage;
+  /**
+   * The identifier of the request.
+   */
+  "requestId"?: string;
+  /**
+   * The status of the response.
+   */
+  "status"?: CIAppResponseStatus;
+  /**
+   * A list of warnings (non-fatal errors) encountered. Partial results may return if
+   * warnings are present in the response.
+   */
+  "warnings"?: Array<CIAppWarning>;
+
+  /**
+   * @ignore
+   */
+  "_unparsed"?: boolean;
+
+  /**
+   * @ignore
+   */
+  static readonly attributeTypeMap: AttributeTypeMap = {
+    elapsed: {
+      baseName: "elapsed",
+      type: "number",
+      format: "int64",
+    },
+    page: {
+      baseName: "page",
+      type: "CIAppResponsePage",
+    },
+    requestId: {
+      baseName: "request_id",
+      type: "string",
+    },
+    status: {
+      baseName: "status",
+      type: "CIAppResponseStatus",
+    },
+    warnings: {
+      baseName: "warnings",
+      type: "Array<CIAppWarning>",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return CIAppResponseMetadataWithPagination.attributeTypeMap;
+  }
+
+  public constructor() {}
+}
diff --git a/packages/datadog-api-client-v2/models/CIAppTestEventsResponse.ts b/packages/datadog-api-client-v2/models/CIAppTestEventsResponse.ts
@@ -4,7 +4,7 @@
  * Copyright 2020-Present Datadog, Inc.
  */
 import { CIAppResponseLinks } from "./CIAppResponseLinks";
-import { CIAppResponseMetadata } from "./CIAppResponseMetadata";
+import { CIAppResponseMetadataWithPagination } from "./CIAppResponseMetadataWithPagination";
 import { CIAppTestEvent } from "./CIAppTestEvent";
 
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
@@ -24,7 +24,7 @@ export class CIAppTestEventsResponse {
   /**
    * The metadata associated with a request.
    */
-  "meta"?: CIAppResponseMetadata;
+  "meta"?: CIAppResponseMetadataWithPagination;
 
   /**
    * @ignore
@@ -45,7 +45,7 @@ export class CIAppTestEventsResponse {
     },
     meta: {
       baseName: "meta",
-      type: "CIAppResponseMetadata",
+      type: "CIAppResponseMetadataWithPagination",
     },
   };
 
diff --git a/packages/datadog-api-client-v2/models/CIAppTestsAggregateRequest.ts b/packages/datadog-api-client-v2/models/CIAppTestsAggregateRequest.ts
diff --git a/packages/datadog-api-client-v2/models/ObjectSerializer.ts b/packages/datadog-api-client-v2/models/ObjectSerializer.ts

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:14.101086",`
`8`		`- "spec_repo_commit": "9f8d1169"`
	`7`	`+ "regenerated": "2023-01-11 09:53:49.785215",`
	`8`	`+ "spec_repo_commit": "c22824fc"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.4",`
`12`		`- "regenerated": "2023-01-09 17:15:14.116260",`
`13`		`- "spec_repo_commit": "9f8d1169"`
	`12`	`+ "regenerated": "2023-01-11 09:53:49.795808",`
	`13`	`+ "spec_repo_commit": "c22824fc"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`