Skip to content

Add OpenAPI documentation for security monitoring signals investigation endpoints #2975

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
+3,406 −0
Open

Add OpenAPI documentation for security monitoring signals investigation endpoints #2975

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

Large diffs are not rendered by default.

18 changes: 18 additions & 0 deletions examples/v2/security-monitoring/CreateSignalInvestigation.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Create a security signal investigation returns "OK" response

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

body = DatadogAPIClient::V2::SecurityMonitoringSignalInvestigationRequest.new({
data: DatadogAPIClient::V2::SecurityMonitoringSignalInvestigationRequestData.new({
attributes: DatadogAPIClient::V2::SecurityMonitoringSignalInvestigationRequestAttributes.new({
deployment: "live",
signal_id: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA",
}),
type: DatadogAPIClient::V2::SecurityMonitoringSignalInvestigationType::INVESTIGATION_SIGNAL,
}),
})
p api_instance.create_signal_investigation(body)
8 changes: 8 additions & 0 deletions examples/v2/security-monitoring/GetInvestigationFeedback.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Get investigation feedback returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.get_investigation_feedback".to_sym] = true
end
api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
p api_instance.get_investigation_feedback("signal_id")
35 changes: 35 additions & 0 deletions examples/v2/security-monitoring/UpdateInvestigationFeedback.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Update investigation feedback returns "OK" response

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

body = DatadogAPIClient::V2::SecurityMonitoringSignalInvestigationFeedbackRequest.new({
data: DatadogAPIClient::V2::SecurityMonitoringSignalInvestigationFeedbackRequestData.new({
attributes: DatadogAPIClient::V2::SecurityMonitoringSignalInvestigationFeedbackRequestAttributes.new({
feedback: "positive",
feedback_content: [
DatadogAPIClient::V2::SecurityMonitoringSignalInvestigationFeedbackSection.new({
id: "section-1",
metrics: [
DatadogAPIClient::V2::SecurityMonitoringSignalInvestigationFeedbackMetric.new({
placeholder: "Enter your feedback here",
prompt: "How helpful was this investigation?",
response: "Very helpful",
type: "sentiment",
}),
],
title: "Investigation Quality",
}),
],
incomplete: false,
rating: "positive",
signal_id: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA",
type: "metrics",
}),
type: DatadogAPIClient::V2::SecurityMonitoringSignalInvestigationFeedbackType::INVESTIGATION_FEEDBACK,
}),
})
p api_instance.update_investigation_feedback(body)
9 changes: 9 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 @@ -1660,6 +1660,15 @@
"page_cursor" => "String",
"page_limit" => "Integer",
},
"v2.CreateSignalInvestigation" => {
"body" => "SecurityMonitoringSignalInvestigationRequest",
},
"v2.UpdateInvestigationFeedback" => {
"body" => "SecurityMonitoringSignalInvestigationFeedbackRequest",
},
"v2.GetInvestigationFeedback" => {
"signal_id" => "String",
},
"v2.SearchSecurityMonitoringSignals" => {
"body" => "SecurityMonitoringSignalListRequest",
},
Expand Down
72 changes: 72 additions & 0 deletions features/v2/security_monitoring.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -578,6 +578,30 @@ Feature: Security Monitoring
And the response "data.attributes.exclusion_filters[0].name" is equal to "Exclude staging"
And the response "data.attributes.exclusion_filters[0].query" is equal to "source:staging"

@generated @skip @team:DataDog/k9-cloud-security-platform
Scenario: Create a security signal investigation returns "Bad Request" response
Given operation "CreateSignalInvestigation" enabled
And new "CreateSignalInvestigation" request
And body with value {"data": {"attributes": {"deployment": "live", "signal_id": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA"}, "type": "investigation_signal"}}
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/k9-cloud-security-platform
Scenario: Create a security signal investigation returns "Not Found" response
Given operation "CreateSignalInvestigation" enabled
And new "CreateSignalInvestigation" request
And body with value {"data": {"attributes": {"deployment": "live", "signal_id": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA"}, "type": "investigation_signal"}}
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/k9-cloud-security-platform
Scenario: Create a security signal investigation returns "OK" response
Given operation "CreateSignalInvestigation" enabled
And new "CreateSignalInvestigation" request
And body with value {"data": {"attributes": {"deployment": "live", "signal_id": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA"}, "type": "investigation_signal"}}
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/k9-cloud-security-platform
Scenario: Create a suppression rule returns "Bad Request" response
Given new "CreateSecurityMonitoringSuppression" request
Expand Down Expand Up @@ -1284,6 +1308,30 @@ Feature: Security Monitoring
When the request is sent
Then the response status is 200 Notification rule details.

@generated @skip @team:DataDog/k9-cloud-security-platform
Scenario: Get investigation feedback returns "Bad Request" response
Given operation "GetInvestigationFeedback" enabled
And new "GetInvestigationFeedback" request
And request contains "signal_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 investigation feedback returns "Not Found" response
Given operation "GetInvestigationFeedback" enabled
And new "GetInvestigationFeedback" request
And request contains "signal_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 investigation feedback returns "OK" response
Given operation "GetInvestigationFeedback" enabled
And new "GetInvestigationFeedback" request
And request contains "signal_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 200 OK

@skip-go @skip-java @skip-ruby @team:DataDog/k9-cloud-security-platform
Scenario: Get rule version history returns "OK" response
Given operation "GetRuleVersionHistory" enabled
Expand Down Expand Up @@ -2007,6 +2055,30 @@ Feature: Security Monitoring
And the response "name" is equal to "{{ unique }}-Updated"
And the response "id" has the same value as "security_rule.id"

@generated @skip @team:DataDog/k9-cloud-security-platform
Scenario: Update investigation feedback returns "Bad Request" response
Given operation "UpdateInvestigationFeedback" enabled
And new "UpdateInvestigationFeedback" request
And body with value {"data": {"attributes": {"feedback": "positive", "feedback_content": [{"id": "section-1", "metrics": [{"placeholder": "Enter your feedback here", "prompt": "How helpful was this investigation?", "response": "Very helpful", "type": "sentiment"}], "title": "Investigation Quality"}], "incomplete": false, "rating": "positive", "signal_id": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", "type": "metrics"}, "type": "investigation_feedback"}}
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/k9-cloud-security-platform
Scenario: Update investigation feedback returns "Not Found" response
Given operation "UpdateInvestigationFeedback" enabled
And new "UpdateInvestigationFeedback" request
And body with value {"data": {"attributes": {"feedback": "positive", "feedback_content": [{"id": "section-1", "metrics": [{"placeholder": "Enter your feedback here", "prompt": "How helpful was this investigation?", "response": "Very helpful", "type": "sentiment"}], "title": "Investigation Quality"}], "incomplete": false, "rating": "positive", "signal_id": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", "type": "metrics"}, "type": "investigation_feedback"}}
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/k9-cloud-security-platform
Scenario: Update investigation feedback returns "OK" response
Given operation "UpdateInvestigationFeedback" enabled
And new "UpdateInvestigationFeedback" request
And body with value {"data": {"attributes": {"feedback": "positive", "feedback_content": [{"id": "section-1", "metrics": [{"placeholder": "Enter your feedback here", "prompt": "How helpful was this investigation?", "response": "Very helpful", "type": "sentiment"}], "title": "Investigation Quality"}], "incomplete": false, "rating": "positive", "signal_id": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", "type": "metrics"}, "type": "investigation_feedback"}}
When the request is sent
Then the response status is 200 OK

@team:DataDog/k9-cloud-security-platform
Scenario: Update resource filters returns "Bad Request" response
Given new "UpdateResourceEvaluationFilters" request
Expand Down
18 changes: 18 additions & 0 deletions features/v2/undo.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4579,6 +4579,24 @@
"type": "safe"
}
},
"CreateSignalInvestigation": {
"tag": "Security Monitoring",
"undo": {
"type": "safe"
}
},
"UpdateInvestigationFeedback": {
"tag": "Security Monitoring",
"undo": {
"type": "idempotent"
}
},
"GetInvestigationFeedback": {
"tag": "Security Monitoring",
"undo": {
"type": "safe"
}
},
"SearchSecurityMonitoringSignals": {
"tag": "Security Monitoring",
"undo": {
Expand Down
3 changes: 3 additions & 0 deletions lib/datadog_api_client/configuration.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,8 +210,10 @@ def initialize
"v2.update_open_api": false,
"v2.cancel_threat_hunting_job": false,
"v2.convert_job_result_to_signal": false,
"v2.create_signal_investigation": false,
"v2.delete_threat_hunting_job": false,
"v2.get_finding": false,
"v2.get_investigation_feedback": false,
"v2.get_rule_version_history": false,
"v2.get_secrets_rules": false,
"v2.get_security_monitoring_histsignal": false,
Expand All @@ -227,6 +229,7 @@ def initialize
"v2.mute_findings": false,
"v2.run_threat_hunting_job": false,
"v2.search_security_monitoring_histsignals": false,
"v2.update_investigation_feedback": false,
"v2.create_dataset": false,
"v2.delete_dataset": false,
"v2.get_all_datasets": false,
Expand Down
20 changes: 20 additions & 0 deletions lib/datadog_api_client/inflector.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4341,6 +4341,26 @@ def overrides
"v2.security_monitoring_signal_incidents_update_attributes" => "SecurityMonitoringSignalIncidentsUpdateAttributes",
"v2.security_monitoring_signal_incidents_update_data" => "SecurityMonitoringSignalIncidentsUpdateData",
"v2.security_monitoring_signal_incidents_update_request" => "SecurityMonitoringSignalIncidentsUpdateRequest",
"v2.security_monitoring_signal_investigation_feedback_metric" => "SecurityMonitoringSignalInvestigationFeedbackMetric",
"v2.security_monitoring_signal_investigation_feedback_request" => "SecurityMonitoringSignalInvestigationFeedbackRequest",
"v2.security_monitoring_signal_investigation_feedback_request_attributes" => "SecurityMonitoringSignalInvestigationFeedbackRequestAttributes",
"v2.security_monitoring_signal_investigation_feedback_request_data" => "SecurityMonitoringSignalInvestigationFeedbackRequestData",
"v2.security_monitoring_signal_investigation_feedback_response" => "SecurityMonitoringSignalInvestigationFeedbackResponse",
"v2.security_monitoring_signal_investigation_feedback_response_attributes" => "SecurityMonitoringSignalInvestigationFeedbackResponseAttributes",
"v2.security_monitoring_signal_investigation_feedback_response_data" => "SecurityMonitoringSignalInvestigationFeedbackResponseData",
"v2.security_monitoring_signal_investigation_feedback_section" => "SecurityMonitoringSignalInvestigationFeedbackSection",
"v2.security_monitoring_signal_investigation_feedback_type" => "SecurityMonitoringSignalInvestigationFeedbackType",
"v2.security_monitoring_signal_investigation_request" => "SecurityMonitoringSignalInvestigationRequest",
"v2.security_monitoring_signal_investigation_request_attributes" => "SecurityMonitoringSignalInvestigationRequestAttributes",
"v2.security_monitoring_signal_investigation_request_data" => "SecurityMonitoringSignalInvestigationRequestData",
"v2.security_monitoring_signal_investigation_response" => "SecurityMonitoringSignalInvestigationResponse",
"v2.security_monitoring_signal_investigation_response_attributes" => "SecurityMonitoringSignalInvestigationResponseAttributes",
"v2.security_monitoring_signal_investigation_response_data" => "SecurityMonitoringSignalInvestigationResponseData",
"v2.security_monitoring_signal_investigation_state" => "SecurityMonitoringSignalInvestigationState",
"v2.security_monitoring_signal_investigation_step" => "SecurityMonitoringSignalInvestigationStep",
"v2.security_monitoring_signal_investigation_step_output" => "SecurityMonitoringSignalInvestigationStepOutput",
"v2.security_monitoring_signal_investigation_step_output_verdict" => "SecurityMonitoringSignalInvestigationStepOutputVerdict",
"v2.security_monitoring_signal_investigation_type" => "SecurityMonitoringSignalInvestigationType",
"v2.security_monitoring_signal_list_request" => "SecurityMonitoringSignalListRequest",
"v2.security_monitoring_signal_list_request_filter" => "SecurityMonitoringSignalListRequestFilter",
"v2.security_monitoring_signal_list_request_page" => "SecurityMonitoringSignalListRequestPage",
Expand Down
Loading
Loading