Skip to content

Add custom/rulesets endpoints #2890

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
+6,559 −0
Open

Add custom/rulesets endpoints #2890

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
1,053 changes: 1,053 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions examples/v2/static-analysis/CreateCustomRule.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Create Custom Rule returns "Successfully created" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.create_custom_rule".to_sym] = true
end
api_instance = DatadogAPIClient::V2::StaticAnalysisAPI.new

body = DatadogAPIClient::V2::CustomRuleRequest.new({
data: DatadogAPIClient::V2::CustomRuleRequestData.new({
attributes: DatadogAPIClient::V2::CustomRuleRequestDataAttributes.new({}),
type: DatadogAPIClient::V2::CustomRuleDataType::CUSTOM_RULE,
}),
})
p api_instance.create_custom_rule("ruleset_name", body)
47 changes: 47 additions & 0 deletions examples/v2/static-analysis/CreateCustomRuleRevision.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Create Custom Rule Revision returns "Successfully created" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.create_custom_rule_revision".to_sym] = true
end
api_instance = DatadogAPIClient::V2::StaticAnalysisAPI.new

body = DatadogAPIClient::V2::CustomRuleRevisionRequest.new({
data: DatadogAPIClient::V2::CustomRuleRevisionRequestData.new({
attributes: DatadogAPIClient::V2::CustomRuleRevisionInputAttributes.new({
arguments: [
DatadogAPIClient::V2::Argument.new({
description: "YXJndW1lbnQgZGVzY3JpcHRpb24=",
name: "YXJndW1lbnRfbmFtZQ==",
}),
],
category: DatadogAPIClient::V2::CustomRuleRevisionAttributesCategory::SECURITY,
code: "Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ==",
creation_message: "Initial revision",
cve: "CVE-2024-1234",
cwe: "CWE-79",
description: "bG9uZyBkZXNjcmlwdGlvbg==",
documentation_url: "https://docs.example.com/rules/my-rule",
is_published: false,
is_testing: false,
language: DatadogAPIClient::V2::Language::PYTHON,
severity: DatadogAPIClient::V2::CustomRuleRevisionAttributesSeverity::ERROR,
short_description: "c2hvcnQgZGVzY3JpcHRpb24=",
should_use_ai_fix: false,
tags: [
"security",
"custom",
],
tests: [
DatadogAPIClient::V2::CustomRuleRevisionTest.new({
annotation_count: 1,
code: "Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ==",
filename: "test.yaml",
}),
],
tree_sitter_query: "Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ==",
}),
type: DatadogAPIClient::V2::CustomRuleRevisionDataType::CUSTOM_RULE_REVISION,
}),
})
p api_instance.create_custom_rule_revision("ruleset_name", "rule_name", body)
8 changes: 8 additions & 0 deletions examples/v2/static-analysis/DeleteCustomRule.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Delete Custom Rule returns "Successfully deleted" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.delete_custom_rule".to_sym] = true
end
api_instance = DatadogAPIClient::V2::StaticAnalysisAPI.new
p api_instance.delete_custom_rule("ruleset_name", "rule_name")
8 changes: 8 additions & 0 deletions examples/v2/static-analysis/DeleteCustomRuleset.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Delete Custom Ruleset returns "Successfully deleted" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.delete_custom_ruleset".to_sym] = true
end
api_instance = DatadogAPIClient::V2::StaticAnalysisAPI.new
p api_instance.delete_custom_ruleset("ruleset_name")
8 changes: 8 additions & 0 deletions examples/v2/static-analysis/GetCustomRule.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Show Custom Rule returns "Successful response" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.get_custom_rule".to_sym] = true
end
api_instance = DatadogAPIClient::V2::StaticAnalysisAPI.new
p api_instance.get_custom_rule("ruleset_name", "rule_name")
8 changes: 8 additions & 0 deletions examples/v2/static-analysis/GetCustomRuleset.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Show Custom Ruleset returns "Successful response" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.get_custom_ruleset".to_sym] = true
end
api_instance = DatadogAPIClient::V2::StaticAnalysisAPI.new
p api_instance.get_custom_ruleset("ruleset_name")
8 changes: 8 additions & 0 deletions examples/v2/static-analysis/ListCustomRuleRevisions.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# List Custom Rule Revisions returns "Successful response" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.list_custom_rule_revisions".to_sym] = true
end
api_instance = DatadogAPIClient::V2::StaticAnalysisAPI.new
p api_instance.list_custom_rule_revisions("ruleset_name", "rule_name")
15 changes: 15 additions & 0 deletions examples/v2/static-analysis/RevertCustomRuleRevision.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Revert Custom Rule Revision returns "Successfully reverted" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.revert_custom_rule_revision".to_sym] = true
end
api_instance = DatadogAPIClient::V2::StaticAnalysisAPI.new

body = DatadogAPIClient::V2::RevertCustomRuleRevisionRequest.new({
data: DatadogAPIClient::V2::RevertCustomRuleRevisionRequestData.new({
attributes: DatadogAPIClient::V2::RevertCustomRuleRevisionRequestDataAttributes.new({}),
type: DatadogAPIClient::V2::RevertCustomRuleRevisionDataType::REVERT_CUSTOM_RULE_REVISION_REQUEST,
}),
})
p api_instance.revert_custom_rule_revision("ruleset_name", "rule_name", body)
8 changes: 8 additions & 0 deletions examples/v2/static-analysis/ShowCustomRuleRevision.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Show Custom Rule Revision returns "Successful response" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.show_custom_rule_revision".to_sym] = true
end
api_instance = DatadogAPIClient::V2::StaticAnalysisAPI.new
p api_instance.show_custom_rule_revision("ruleset_name", "rule_name", "id")
63 changes: 63 additions & 0 deletions examples/v2/static-analysis/UpdateCustomRuleset.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Update Custom Ruleset returns "Successfully updated" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.update_custom_ruleset".to_sym] = true
end
api_instance = DatadogAPIClient::V2::StaticAnalysisAPI.new

body = DatadogAPIClient::V2::CustomRulesetRequest.new({
data: DatadogAPIClient::V2::CustomRulesetRequestData.new({
attributes: DatadogAPIClient::V2::CustomRulesetRequestDataAttributes.new({
rules: [
DatadogAPIClient::V2::CustomRule.new({
created_at: "2026-01-09T13:00:57.473141Z",
created_by: "foobarbaz",
last_revision: DatadogAPIClient::V2::CustomRuleRevision.new({
attributes: DatadogAPIClient::V2::CustomRuleRevisionAttributes.new({
arguments: [
DatadogAPIClient::V2::Argument.new({
description: "YXJndW1lbnQgZGVzY3JpcHRpb24=",
name: "YXJndW1lbnRfbmFtZQ==",
}),
],
category: DatadogAPIClient::V2::CustomRuleRevisionAttributesCategory::SECURITY,
checksum: "8a66c4e4e631099ad71be3c1ea3ea8fc2d57193e56db2c296e2dd8a508b26b99",
code: "Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ==",
created_at: "2026-01-09T13:00:57.473141Z",
created_by: "foobarbaz",
creation_message: "Initial revision",
cve: "CVE-2024-1234",
cwe: "CWE-79",
description: "bG9uZyBkZXNjcmlwdGlvbg==",
documentation_url: "https://docs.example.com/rules/my-rule",
is_published: false,
is_testing: false,
language: DatadogAPIClient::V2::Language::PYTHON,
severity: DatadogAPIClient::V2::CustomRuleRevisionAttributesSeverity::ERROR,
short_description: "c2hvcnQgZGVzY3JpcHRpb24=",
should_use_ai_fix: false,
tags: [
"security",
"custom",
],
tests: [
DatadogAPIClient::V2::CustomRuleRevisionTest.new({
annotation_count: 1,
code: "Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ==",
filename: "test.yaml",
}),
],
tree_sitter_query: "Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ==",
}),
id: "revision-123",
type: DatadogAPIClient::V2::CustomRuleRevisionDataType::CUSTOM_RULE_REVISION,
}),
name: "my-rule",
}),
],
}),
type: DatadogAPIClient::V2::CustomRulesetDataType::CUSTOM_RULESET,
}),
})
p api_instance.update_custom_ruleset("ruleset_name", body)
43 changes: 43 additions & 0 deletions features/scenarios_model_mapping.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3240,6 +3240,49 @@
"v2.CreateSCAResolveVulnerableSymbols" => {
"body" => "ResolveVulnerableSymbolsRequest",
},
"v2.DeleteCustomRuleset" => {
"ruleset_name" => "String",
},
"v2.GetCustomRuleset" => {
"ruleset_name" => "String",
},
"v2.UpdateCustomRuleset" => {
"ruleset_name" => "String",
"body" => "CustomRulesetRequest",
},
"v2.CreateCustomRule" => {
"ruleset_name" => "String",
"body" => "CustomRuleRequest",
},
"v2.DeleteCustomRule" => {
"ruleset_name" => "String",
"rule_name" => "String",
},
"v2.GetCustomRule" => {
"ruleset_name" => "String",
"rule_name" => "String",
},
"v2.ListCustomRuleRevisions" => {
"ruleset_name" => "String",
"rule_name" => "String",
"page_offset" => "Integer",
"page_limit" => "Integer",
},
"v2.CreateCustomRuleRevision" => {
"ruleset_name" => "String",
"rule_name" => "String",
"body" => "CustomRuleRevisionRequest",
},
"v2.RevertCustomRuleRevision" => {
"ruleset_name" => "String",
"rule_name" => "String",
"body" => "RevertCustomRuleRevisionRequest",
},
"v2.ShowCustomRuleRevision" => {
"ruleset_name" => "String",
"rule_name" => "String",
"id" => "String",
},
"v2.SetOnDemandConcurrencyCap" => {
"body" => "OnDemandConcurrencyCapAttributes",
},
Expand Down
Loading
Loading