Skip to content

Remove Compliance Findings rule-based view endpoint from OpenAPI v2 #4032

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Remove Compliance Findings rule-based view endpoint from OpenAPI v2 #4032

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123847,7 +123847,10 @@ paths:
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
/api/v2/compliance_findings/rule_based_view:
get:
deprecated: true
description: |-
**This endpoint is deprecated.** Use the [Security Monitoring - Search Security Findings](https://docs.datadoghq.com/api/latest/security-monitoring/search-security-findings/) endpoint instead.

Get an aggregated view of compliance rules with their pass, fail, and muted finding counts.
Supports filtering by compliance framework, framework version, and additional query filters.
operationId: GetRuleBasedView
Expand Down Expand Up @@ -123925,6 +123928,7 @@ paths:
operator: OR
permissions:
- security_monitoring_findings_read
x-sunset: "2027-06-26"
x-unstable: |-
**Note**: This endpoint is in Preview and subject to change.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
Expand Down
19 changes: 18 additions & 1 deletion src/main/java/com/datadog/api/client/v2/api/ComplianceApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,9 @@ public GetRuleBasedViewOptionalParameters query(String query) {
* @param to Timestamp of the query end, in milliseconds since the Unix epoch. (required)
* @return RuleBasedViewResponse
* @throws ApiException if fails to make API call
* @deprecated
*/
@Deprecated
public RuleBasedViewResponse getRuleBasedView(Long to) throws ApiException {
return getRuleBasedViewWithHttpInfo(to, new GetRuleBasedViewOptionalParameters()).getData();
}
Expand All @@ -149,7 +151,9 @@ public RuleBasedViewResponse getRuleBasedView(Long to) throws ApiException {
*
* @param to Timestamp of the query end, in milliseconds since the Unix epoch. (required)
* @return CompletableFuture<RuleBasedViewResponse>
* @deprecated
*/
@Deprecated
public CompletableFuture<RuleBasedViewResponse> getRuleBasedViewAsync(Long to) {
return getRuleBasedViewWithHttpInfoAsync(to, new GetRuleBasedViewOptionalParameters())
.thenApply(
Expand All @@ -167,7 +171,9 @@ public CompletableFuture<RuleBasedViewResponse> getRuleBasedViewAsync(Long to) {
* @param parameters Optional parameters for the request.
* @return RuleBasedViewResponse
* @throws ApiException if fails to make API call
* @deprecated
*/
@Deprecated
public RuleBasedViewResponse getRuleBasedView(
Long to, GetRuleBasedViewOptionalParameters parameters) throws ApiException {
return getRuleBasedViewWithHttpInfo(to, parameters).getData();
Expand All @@ -181,7 +187,9 @@ public RuleBasedViewResponse getRuleBasedView(
* @param to Timestamp of the query end, in milliseconds since the Unix epoch. (required)
* @param parameters Optional parameters for the request.
* @return CompletableFuture&lt;RuleBasedViewResponse&gt;
* @deprecated
*/
@Deprecated
public CompletableFuture<RuleBasedViewResponse> getRuleBasedViewAsync(
Long to, GetRuleBasedViewOptionalParameters parameters) {
return getRuleBasedViewWithHttpInfoAsync(to, parameters)
Expand All @@ -192,7 +200,11 @@ public CompletableFuture<RuleBasedViewResponse> getRuleBasedViewAsync(
}

/**
* Get an aggregated view of compliance rules with their pass, fail, and muted finding counts.
* <strong>This endpoint is deprecated.</strong> Use the <a
* href="https://docs.datadoghq.com/api/latest/security-monitoring/search-security-findings/">Security
* Monitoring - Search Security Findings</a> endpoint instead.
*
* <p>Get an aggregated view of compliance rules with their pass, fail, and muted finding counts.
* Supports filtering by compliance framework, framework version, and additional query filters.
*
* @param to Timestamp of the query end, in milliseconds since the Unix epoch. (required)
Expand All @@ -209,7 +221,10 @@ public CompletableFuture<RuleBasedViewResponse> getRuleBasedViewAsync(
* <tr><td> 429 </td><td> Too many requests </td><td> - </td></tr>
* <tr><td> 503 </td><td> Service Unavailable </td><td> - </td></tr>
* </table>
*
* @deprecated
*/
@Deprecated
public ApiResponse<RuleBasedViewResponse> getRuleBasedViewWithHttpInfo(
Long to, GetRuleBasedViewOptionalParameters parameters) throws ApiException {
// Check if unstable operation is enabled
Expand Down Expand Up @@ -278,7 +293,9 @@ public ApiResponse<RuleBasedViewResponse> getRuleBasedViewWithHttpInfo(
* @param to Timestamp of the query end, in milliseconds since the Unix epoch. (required)
* @param parameters Optional parameters for the request.
* @return CompletableFuture&lt;ApiResponse&lt;RuleBasedViewResponse&gt;&gt;
* @deprecated
*/
@Deprecated
public CompletableFuture<ApiResponse<RuleBasedViewResponse>> getRuleBasedViewWithHttpInfoAsync(
Long to, GetRuleBasedViewOptionalParameters parameters) {
// Check if unstable operation is enabled
Expand Down
Loading