Skip to content

security_monitoring - Make Rule History endpoint public #2140

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.

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2025-04-17 13:26:12.084116",
"spec_repo_commit": "12ab5180"
"regenerated": "2025-04-18 16:37:19.862200",
"spec_repo_commit": "8ff9b6bd"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-04-17 13:26:12.100267",
"spec_repo_commit": "12ab5180"
"regenerated": "2025-04-18 16:37:19.880479",
"spec_repo_commit": "8ff9b6bd"
}
}
}
1 change: 0 additions & 1 deletion .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -52698,7 +52698,6 @@ paths:
operator: OR
permissions:
- security_monitoring_rules_read
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.'
/api/v2/security_monitoring/signals:
get:
description: 'The list endpoint returns security signals that match a search
Expand Down
1 change: 0 additions & 1 deletion examples/v2/security-monitoring/GetRuleVersionHistory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
configuration.unstableOperations["v2.getRuleVersionHistory"] = true;
const apiInstance = new v2.SecurityMonitoringApi(configuration);

const params: v2.SecurityMonitoringApiGetRuleVersionHistoryRequest = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
configuration.unstableOperations["v2.getRuleVersionHistory"] = true;
const apiInstance = new v2.SecurityMonitoringApi(configuration);

// there is a valid "security_rule" in the system
Expand Down
12 changes: 4 additions & 8 deletions features/v2/security_monitoring.feature
Original file line number Diff line number Diff line change
Expand Up @@ -604,24 +604,21 @@ Feature: Security Monitoring

@generated @skip @team:DataDog/k9-cloud-security-platform
Scenario: Get a rule's version history returns "Bad Request" response
Given operation "GetRuleVersionHistory" enabled
And new "GetRuleVersionHistory" request
Given new "GetRuleVersionHistory" request
And request contains "rule_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/k9-cloud-security-platform
Scenario: Get a rule's version history returns "Not Found" response
Given operation "GetRuleVersionHistory" enabled
And new "GetRuleVersionHistory" request
Given new "GetRuleVersionHistory" request
And request contains "rule_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/k9-cloud-security-platform
Scenario: Get a rule's version history returns "OK" response
Given operation "GetRuleVersionHistory" enabled
And new "GetRuleVersionHistory" request
Given new "GetRuleVersionHistory" request
And request contains "rule_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 200 OK
Expand Down Expand Up @@ -737,8 +734,7 @@ Feature: Security Monitoring

@skip-go @skip-java @skip-ruby @team:DataDog/k9-cloud-security-platform
Scenario: Get rule version history returns "OK" response
Given operation "GetRuleVersionHistory" enabled
And new "GetRuleVersionHistory" request
Given new "GetRuleVersionHistory" request
And there is a valid "security_rule" in the system
And request contains "rule_id" parameter from "security_rule.id"
When the request is sent
Expand Down
1 change: 0 additions & 1 deletion packages/datadog-api-client-common/configuration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,6 @@ export function createConfiguration(
"v2.deleteHistoricalJob": false,
"v2.getFinding": false,
"v2.getHistoricalJob": false,
"v2.getRuleVersionHistory": false,
"v2.getSBOM": false,
"v2.listFindings": false,
"v2.listHistoricalJobs": false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -963,11 +963,6 @@ export class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
): Promise<RequestContext> {
const _config = _options || this.configuration;

logger.warn("Using unstable operation 'getRuleVersionHistory'");
if (!_config.unstableOperations["v2.getRuleVersionHistory"]) {
throw new Error("Unstable operation 'getRuleVersionHistory' is disabled");
}

// verify required parameter 'ruleId' is not null or undefined
if (ruleId === null || ruleId === undefined) {
throw new RequiredError("ruleId", "getRuleVersionHistory");
Expand Down