Skip to content

Commit faf6b7d

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add pagination and sorting parameters on suppression list (#3385)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 4e9626a commit faf6b7d

File tree

26 files changed

+1370
-55
lines changed

26 files changed

+1370
-55
lines changed

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 80 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49256,6 +49256,18 @@ components:
4925649256
meta:
4925749257
$ref: '#/components/schemas/ResponseMetaAttributes'
4925849258
type: object
49259+
SecurityMonitoringPaginatedSuppressionsResponse:
49260+
description: Response object containing the available suppression rules with
49261+
pagination metadata.
49262+
properties:
49263+
data:
49264+
description: A list of suppressions objects.
49265+
items:
49266+
$ref: '#/components/schemas/SecurityMonitoringSuppression'
49267+
type: array
49268+
meta:
49269+
$ref: '#/components/schemas/SecurityMonitoringSuppressionsMeta'
49270+
type: object
4925949271
SecurityMonitoringReferenceTable:
4926049272
description: Reference tables used in the queries.
4926149273
properties:
@@ -51405,6 +51417,31 @@ components:
5140551417
data:
5140651418
$ref: '#/components/schemas/SecurityMonitoringSuppression'
5140751419
type: object
51420+
SecurityMonitoringSuppressionSort:
51421+
description: The sort parameters used for querying suppression rules.
51422+
enum:
51423+
- name
51424+
- start_date
51425+
- expiration_date
51426+
- update_date
51427+
- enabled
51428+
- -name
51429+
- -start_date
51430+
- -expiration_date
51431+
- -update_date
51432+
- -enabled
51433+
type: string
51434+
x-enum-varnames:
51435+
- NAME
51436+
- START_DATE
51437+
- EXPIRATION_DATE
51438+
- UPDATE_DATE
51439+
- ENABLED
51440+
- NAME_DESCENDING
51441+
- START_DATE_DESCENDING
51442+
- EXPIRATION_DATE_DESCENDING
51443+
- UPDATE_DATE_DESCENDING
51444+
- ENABLED_DESCENDING
5140851445
SecurityMonitoringSuppressionType:
5140951446
default: suppressions
5141051447
description: The type of the resource. The value should always be `suppressions`.
@@ -51500,6 +51537,31 @@ components:
5150051537
required:
5150151538
- data
5150251539
type: object
51540+
SecurityMonitoringSuppressionsMeta:
51541+
description: Metadata for the suppression list response.
51542+
properties:
51543+
page:
51544+
$ref: '#/components/schemas/SecurityMonitoringSuppressionsPageMeta'
51545+
type: object
51546+
SecurityMonitoringSuppressionsPageMeta:
51547+
description: Pagination metadata.
51548+
properties:
51549+
pageNumber:
51550+
description: Current page number.
51551+
example: 0
51552+
format: int64
51553+
type: integer
51554+
pageSize:
51555+
description: Current page size.
51556+
example: 2
51557+
format: int64
51558+
type: integer
51559+
totalCount:
51560+
description: Total count of suppressions.
51561+
example: 2
51562+
format: int64
51563+
type: integer
51564+
type: object
5150351565
SecurityMonitoringSuppressionsResponse:
5150451566
description: Response object containing the available suppression rules.
5150551567
properties:
@@ -85670,12 +85732,29 @@ paths:
8567085732
required: false
8567185733
schema:
8567285734
type: string
85735+
- description: Attribute used to sort the list of suppression rules. Prefix
85736+
with `-` to sort in descending order.
85737+
in: query
85738+
name: sort
85739+
required: false
85740+
schema:
85741+
$ref: '#/components/schemas/SecurityMonitoringSuppressionSort'
85742+
- description: Size for a given page. Use `-1` to return all items.
85743+
in: query
85744+
name: page[size]
85745+
required: false
85746+
schema:
85747+
default: -1
85748+
example: 10
85749+
format: int64
85750+
type: integer
85751+
- $ref: '#/components/parameters/PageNumber'
8567385752
responses:
8567485753
'200':
8567585754
content:
8567685755
application/json:
8567785756
schema:
85678-
$ref: '#/components/schemas/SecurityMonitoringSuppressionsResponse'
85757+
$ref: '#/components/schemas/SecurityMonitoringPaginatedSuppressionsResponse'
8567985758
description: OK
8568085759
'403':
8568185760
$ref: '#/components/responses/NotAuthorizedResponse'

‎examples/v2/security-monitoring/ListSecurityMonitoringSuppressions.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
import com.datadog.api.client.ApiClient;
44
import com.datadog.api.client.ApiException;
55
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
6-
import com.datadog.api.client.v2.model.SecurityMonitoringSuppressionsResponse;
6+
import com.datadog.api.client.v2.model.SecurityMonitoringPaginatedSuppressionsResponse;
77

88
public class Example {
99
public static void main(String[] args) {
1010
ApiClient defaultClient = ApiClient.getDefaultApiClient();
1111
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
1212

1313
try {
14-
SecurityMonitoringSuppressionsResponse result =
14+
SecurityMonitoringPaginatedSuppressionsResponse result =
1515
apiInstance.listSecurityMonitoringSuppressions();
1616
System.out.println(result);
1717
} catch (ApiException e) {

‎examples/v2/security-monitoring/ListSecurityMonitoringSuppressions_1315707136.java‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
// Get all suppression rules returns "OK" response with sort ascending
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
6+
import com.datadog.api.client.v2.api.SecurityMonitoringApi.ListSecurityMonitoringSuppressionsOptionalParameters;
7+
import com.datadog.api.client.v2.model.SecurityMonitoringPaginatedSuppressionsResponse;
8+
import com.datadog.api.client.v2.model.SecurityMonitoringSuppressionSort;
9+
10+
public class Example {
11+
public static void main(String[] args) {
12+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
13+
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
14+
15+
// there is a valid "suppression" in the system
16+
String SUPPRESSION_DATA_ID = System.getenv("SUPPRESSION_DATA_ID");
17+
18+
// there is a valid "suppression2" in the system
19+
String SUPPRESSION2_DATA_ID = System.getenv("SUPPRESSION2_DATA_ID");
20+
21+
try {
22+
SecurityMonitoringPaginatedSuppressionsResponse result =
23+
apiInstance.listSecurityMonitoringSuppressions(
24+
new ListSecurityMonitoringSuppressionsOptionalParameters()
25+
.sort(SecurityMonitoringSuppressionSort.NAME)
26+
.query("id:3dd-0uc-h1s OR id:886e6c3e-e543-049c-ee1b-56a1110295c0"));
27+
System.out.println(result);
28+
} catch (ApiException e) {
29+
System.err.println(
30+
"Exception when calling SecurityMonitoringApi#listSecurityMonitoringSuppressions");
31+
System.err.println("Status code: " + e.getCode());
32+
System.err.println("Reason: " + e.getResponseBody());
33+
System.err.println("Response headers: " + e.getResponseHeaders());
34+
e.printStackTrace();
35+
}
36+
}
37+
}

‎examples/v2/security-monitoring/ListSecurityMonitoringSuppressions_1741429096.java‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
// Get all suppression rules returns "OK" response with sort descending
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
6+
import com.datadog.api.client.v2.api.SecurityMonitoringApi.ListSecurityMonitoringSuppressionsOptionalParameters;
7+
import com.datadog.api.client.v2.model.SecurityMonitoringPaginatedSuppressionsResponse;
8+
import com.datadog.api.client.v2.model.SecurityMonitoringSuppressionSort;
9+
10+
public class Example {
11+
public static void main(String[] args) {
12+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
13+
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
14+
15+
// there is a valid "suppression" in the system
16+
String SUPPRESSION_DATA_ID = System.getenv("SUPPRESSION_DATA_ID");
17+
18+
// there is a valid "suppression2" in the system
19+
String SUPPRESSION2_DATA_ID = System.getenv("SUPPRESSION2_DATA_ID");
20+
21+
try {
22+
SecurityMonitoringPaginatedSuppressionsResponse result =
23+
apiInstance.listSecurityMonitoringSuppressions(
24+
new ListSecurityMonitoringSuppressionsOptionalParameters()
25+
.sort(SecurityMonitoringSuppressionSort.NAME_DESCENDING)
26+
.query("id:3dd-0uc-h1s OR id:886e6c3e-e543-049c-ee1b-56a1110295c0"));
27+
System.out.println(result);
28+
} catch (ApiException e) {
29+
System.err.println(
30+
"Exception when calling SecurityMonitoringApi#listSecurityMonitoringSuppressions");
31+
System.err.println("Status code: " + e.getCode());
32+
System.err.println("Reason: " + e.getResponseBody());
33+
System.err.println("Response headers: " + e.getResponseHeaders());
34+
e.printStackTrace();
35+
}
36+
}
37+
}

‎examples/v2/security-monitoring/ListSecurityMonitoringSuppressions_3985905558.java‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
// Get all suppression rules returns "OK" response with pagination
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
6+
import com.datadog.api.client.v2.api.SecurityMonitoringApi.ListSecurityMonitoringSuppressionsOptionalParameters;
7+
import com.datadog.api.client.v2.model.SecurityMonitoringPaginatedSuppressionsResponse;
8+
9+
public class Example {
10+
public static void main(String[] args) {
11+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
12+
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
13+
14+
// there is a valid "suppression" in the system
15+
String SUPPRESSION_DATA_ID = System.getenv("SUPPRESSION_DATA_ID");
16+
17+
// there is a valid "suppression2" in the system
18+
String SUPPRESSION2_DATA_ID = System.getenv("SUPPRESSION2_DATA_ID");
19+
20+
try {
21+
SecurityMonitoringPaginatedSuppressionsResponse result =
22+
apiInstance.listSecurityMonitoringSuppressions(
23+
new ListSecurityMonitoringSuppressionsOptionalParameters()
24+
.pageSize(1L)
25+
.pageNumber(0L)
26+
.query("id:3dd-0uc-h1s OR id:886e6c3e-e543-049c-ee1b-56a1110295c0"));
27+
System.out.println(result);
28+
} catch (ApiException e) {
29+
System.err.println(
30+
"Exception when calling SecurityMonitoringApi#listSecurityMonitoringSuppressions");
31+
System.err.println("Status code: " + e.getCode());
32+
System.err.println("Reason: " + e.getResponseBody());
33+
System.err.println("Response headers: " + e.getResponseHeaders());
34+
e.printStackTrace();
35+
}
36+
}
37+
}

0 commit comments

Comments
 (0)