Skip to content

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

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
+9 −1
Open

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

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
6 changes: 5 additions & 1 deletion src/datadog_api_client/v2/api/compliance_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
from __future__ import annotations

from typing import Any, Dict, Union
import warnings

from datadog_api_client.api_client import ApiClient, Endpoint as _Endpoint
from datadog_api_client.configuration import Configuration
Expand Down Expand Up @@ -91,7 +92,9 @@ def get_rule_based_view(
is_custom: Union[bool, UnsetType] = unset,
query: Union[str, UnsetType] = unset,
) -> RuleBasedViewResponse:
"""Get the rule-based view of compliance findings.
"""Get the rule-based view of compliance findings. **Deprecated**.

**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.
Expand Down Expand Up @@ -133,4 +136,5 @@ def get_rule_based_view(
if query is not unset:
kwargs["query"] = query

warnings.warn("get_rule_based_view is deprecated", DeprecationWarning, stacklevel=2)
return self._get_rule_based_view_endpoint.call_with_http_info(**kwargs)
Loading