Skip to content

Add OpenAPI documentation for security-triage-api endpoints #3154

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

Add OpenAPI documentation for security-triage-api endpoints #3154

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

Large diffs are not rendered by default.

140 changes: 140 additions & 0 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13129,6 +13129,55 @@ datadog\_api\_client.v2.model.intake\_payload\_accepted module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.integration\_assignment\_data\_attributes\_request module
---------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.integration_assignment_data_attributes_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.integration\_assignment\_data\_attributes\_request\_action module
-----------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.integration_assignment_data_attributes_request_action
:members:
:show-inheritance:

datadog\_api\_client.v2.model.integration\_assignment\_data\_attributes\_request\_assignment module
---------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.integration_assignment_data_attributes_request_assignment
:members:
:show-inheritance:

datadog\_api\_client.v2.model.integration\_assignment\_data\_attributes\_request\_type module
---------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.integration_assignment_data_attributes_request_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.integration\_assignment\_data\_request module
---------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.integration_assignment_data_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.integration\_assignment\_request module
---------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.integration_assignment_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.integration\_assignment\_type module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.integration_assignment_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.integration\_incident module
----------------------------------------------------------

Expand Down Expand Up @@ -13815,6 +13864,62 @@ datadog\_api\_client.v2.model.jira\_issue module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.jira\_issue\_custom\_fields module
----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.jira_issue_custom_fields
:members:
:show-inheritance:

datadog\_api\_client.v2.model.jira\_issue\_data\_attributes\_request module
---------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.jira_issue_data_attributes_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.jira\_issue\_data\_attributes\_request\_mode module
---------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.jira_issue_data_attributes_request_mode
:members:
:show-inheritance:

datadog\_api\_client.v2.model.jira\_issue\_data\_meta module
------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.jira_issue_data_meta
:members:
:show-inheritance:

datadog\_api\_client.v2.model.jira\_issue\_data\_request module
---------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.jira_issue_data_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.jira\_issue\_finding module
---------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.jira_issue_finding
:members:
:show-inheritance:

datadog\_api\_client.v2.model.jira\_issue\_finding\_id module
-------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.jira_issue_finding_id
:members:
:show-inheritance:

datadog\_api\_client.v2.model.jira\_issue\_request module
---------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.jira_issue_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.jira\_issue\_result module
--------------------------------------------------------

Expand Down Expand Up @@ -13913,13 +14018,48 @@ datadog\_api\_client.v2.model.jira\_issue\_templates\_response module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.jira\_issue\_type module
------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.jira_issue_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.jira\_issues\_data\_type module
-------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.jira_issues_data_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.jira\_issues\_metadata\_data\_attributes\_response module
---------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.jira_issues_metadata_data_attributes_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.jira\_issues\_metadata\_data\_response module
---------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.jira_issues_metadata_data_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.jira\_issues\_metadata\_response module
---------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.jira_issues_metadata_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.jira\_issues\_metadata\_type module
-----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.jira_issues_metadata_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.job\_create\_response module
----------------------------------------------------------

Expand Down
45 changes: 45 additions & 0 deletions examples/v2/security-monitoring/AssignIntegrationIssues.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
"""
Assign or un-assign Jira issues to security findings returns "Accepted" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
from datadog_api_client.v2.model.integration_assignment_data_attributes_request import (
IntegrationAssignmentDataAttributesRequest,
)
from datadog_api_client.v2.model.integration_assignment_data_attributes_request_action import (
IntegrationAssignmentDataAttributesRequestAction,
)
from datadog_api_client.v2.model.integration_assignment_data_attributes_request_assignment import (
IntegrationAssignmentDataAttributesRequestAssignment,
)
from datadog_api_client.v2.model.integration_assignment_data_attributes_request_type import (
IntegrationAssignmentDataAttributesRequestType,
)
from datadog_api_client.v2.model.integration_assignment_data_request import IntegrationAssignmentDataRequest
from datadog_api_client.v2.model.integration_assignment_request import IntegrationAssignmentRequest
from datadog_api_client.v2.model.integration_assignment_type import IntegrationAssignmentType

body = IntegrationAssignmentRequest(
data=IntegrationAssignmentDataRequest(
attributes=IntegrationAssignmentDataAttributesRequest(
action=IntegrationAssignmentDataAttributesRequestAction.ASSIGN,
assignment=IntegrationAssignmentDataAttributesRequestAssignment(
jira={
"https://jira.example.com/browse/SEC-123": [
"MDBjMzdhYzgyNGZkZGJiZmY0OGNmYjNiMWQ2ODY0YmR-OTc0YjMzNjM1Y2UyODA2YTEyNWQxYmNkZjhmODllNzg=",
],
},
),
type=IntegrationAssignmentDataAttributesRequestType.FINDINGS,
),
id="some_id",
type=IntegrationAssignmentType.ISSUE_ASSIGNMENT,
),
)

configuration = Configuration()
configuration.unstable_operations["assign_integration_issues"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
api_instance.assign_integration_issues(body=body)
77 changes: 77 additions & 0 deletions examples/v2/security-monitoring/CreateJiraIssue.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
"""
Create Jira issues for security findings returns "Accepted" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
from datadog_api_client.v2.model.finding_status import FindingStatus
from datadog_api_client.v2.model.jira_issue_data_attributes_request import JiraIssueDataAttributesRequest
from datadog_api_client.v2.model.jira_issue_data_attributes_request_mode import JiraIssueDataAttributesRequestMode
from datadog_api_client.v2.model.jira_issue_data_meta import JiraIssueDataMeta
from datadog_api_client.v2.model.jira_issue_data_request import JiraIssueDataRequest
from datadog_api_client.v2.model.jira_issue_finding import JiraIssueFinding
from datadog_api_client.v2.model.jira_issue_finding_id import JiraIssueFindingId
from datadog_api_client.v2.model.jira_issue_request import JiraIssueRequest
from datadog_api_client.v2.model.jira_issue_type import JiraIssueType

body = JiraIssueRequest(
data=JiraIssueDataRequest(
attributes=JiraIssueDataAttributesRequest(
account_id="f7ccdf99-0e22-4378-bdf9-03fde5379fea",
fields=None,
issue_type="story",
issuetype_id="1235",
mode=JiraIssueDataAttributesRequestMode.SINGLE,
project_id="1234",
project_key="SEC",
),
id="ID",
meta=JiraIssueDataMeta(
findings=[
JiraIssueFinding(
description="Description",
ids=[
JiraIssueFindingId(
discovered=123213123,
id="afa-afa-hze",
resource="Resource",
tags="akjasd:asdsad",
),
],
impacted=1,
references="",
remediation="Remediation",
severity=FindingStatus.CRITICAL,
title="Title",
type="ciem",
),
],
vulnerabilities=[
JiraIssueFinding(
description="Description",
ids=[
JiraIssueFindingId(
discovered=123213123,
id="afa-afa-hze",
resource="Resource",
tags="akjasd:asdsad",
),
],
impacted=1,
references="",
remediation="Remediation",
severity=FindingStatus.CRITICAL,
title="Title",
type="ciem",
),
],
),
type=JiraIssueType.JIRA_ISSUE,
),
)

configuration = Configuration()
configuration.unstable_operations["create_jira_issue"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
api_instance.create_jira_issue(body=body)
16 changes: 16 additions & 0 deletions examples/v2/security-monitoring/GetJiraIssueMetadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Get Jira issue metadata returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi

configuration = Configuration()
configuration.unstable_operations["get_jira_issue_metadata"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.get_jira_issue_metadata(
url="url",
)

print(response)
3 changes: 3 additions & 0 deletions src/datadog_api_client/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,12 +267,15 @@ def __init__(
"v2.list_apis": False,
"v2.update_open_api": False,
"v2.activate_content_pack": False,
"v2.assign_integration_issues": False,
"v2.cancel_threat_hunting_job": False,
"v2.convert_job_result_to_signal": False,
"v2.create_jira_issue": False,
"v2.deactivate_content_pack": False,
"v2.delete_threat_hunting_job": False,
"v2.get_content_packs_states": False,
"v2.get_finding": False,
"v2.get_jira_issue_metadata": False,
"v2.get_rule_version_history": False,
"v2.get_secrets_rules": False,
"v2.get_security_monitoring_histsignal": False,
Expand Down
Loading