Skip to content

Add OpenAPI documentation for case-rapid-api relationship endpoints #3135

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 case-rapid-api relationship endpoints #3135

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

Large diffs are not rendered by default.

119 changes: 119 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 @@ -12240,6 +12240,20 @@ datadog\_api\_client.v2.model.incident\_related\_object module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_relationship\_data module
-----------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_resource\_type module
-------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_responders\_type module
---------------------------------------------------------------

Expand Down Expand Up @@ -13451,6 +13465,55 @@ datadog\_api\_client.v2.model.jira\_issue module
:members:
:show-inheritance:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Expand Down Expand Up @@ -16097,6 +16160,27 @@ datadog\_api\_client.v2.model.ms\_teams\_integration\_metadata\_teams\_item modu
:members:
:show-inheritance:

datadog\_api\_client.v2.model.notebook\_create\_data module
-----------------------------------------------------------

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

datadog\_api\_client.v2.model.notebook\_create\_request module
--------------------------------------------------------------

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

datadog\_api\_client.v2.model.notebook\_resource\_type module
-------------------------------------------------------------

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

datadog\_api\_client.v2.model.notebook\_trigger\_wrapper module
---------------------------------------------------------------

Expand Down Expand Up @@ -19961,6 +20045,13 @@ datadog\_api\_client.v2.model.relationship\_to\_incident\_postmortem\_data modul
:members:
:show-inheritance:

datadog\_api\_client.v2.model.relationship\_to\_incident\_request module
------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.relationship\_to\_incident\_responder\_data module
--------------------------------------------------------------------------------

Expand Down Expand Up @@ -24686,6 +24777,34 @@ datadog\_api\_client.v2.model.service\_now\_ticket module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.service\_now\_ticket\_create\_attributes module
-----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.service\_now\_ticket\_create\_data module
-----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.service\_now\_ticket\_create\_request module
--------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.service\_now\_ticket\_resource\_type module
-------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.service\_now\_ticket\_result module
-----------------------------------------------------------------

Expand Down
28 changes: 28 additions & 0 deletions examples/v2/case-management/CreateCaseJiraIssue.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
"""
Create Jira issue for case returns "Accepted" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
from datadog_api_client.v2.model.jira_issue_create_attributes import JiraIssueCreateAttributes
from datadog_api_client.v2.model.jira_issue_create_data import JiraIssueCreateData
from datadog_api_client.v2.model.jira_issue_create_request import JiraIssueCreateRequest
from datadog_api_client.v2.model.jira_issue_resource_type import JiraIssueResourceType

body = JiraIssueCreateRequest(
data=JiraIssueCreateData(
attributes=JiraIssueCreateAttributes(
fields=dict(),
issue_type_id="10001",
jira_account_id="1234",
project_id="5678",
),
type=JiraIssueResourceType.ISSUES,
),
)

configuration = Configuration()
configuration.unstable_operations["create_case_jira_issue"] = True
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
api_instance.create_case_jira_issue(case_id="case_id", body=body)
21 changes: 21 additions & 0 deletions examples/v2/case-management/CreateCaseNotebook.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
"""
Create investigation notebook for case returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
from datadog_api_client.v2.model.notebook_create_data import NotebookCreateData
from datadog_api_client.v2.model.notebook_create_request import NotebookCreateRequest
from datadog_api_client.v2.model.notebook_resource_type import NotebookResourceType

body = NotebookCreateRequest(
data=NotebookCreateData(
type=NotebookResourceType.NOTEBOOK,
),
)

configuration = Configuration()
configuration.unstable_operations["create_case_notebook"] = True
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
api_instance.create_case_notebook(case_id="case_id", body=body)
26 changes: 26 additions & 0 deletions examples/v2/case-management/CreateCaseServiceNowTicket.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
"""
Create ServiceNow ticket for case returns "Accepted" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
from datadog_api_client.v2.model.service_now_ticket_create_attributes import ServiceNowTicketCreateAttributes
from datadog_api_client.v2.model.service_now_ticket_create_data import ServiceNowTicketCreateData
from datadog_api_client.v2.model.service_now_ticket_create_request import ServiceNowTicketCreateRequest
from datadog_api_client.v2.model.service_now_ticket_resource_type import ServiceNowTicketResourceType

body = ServiceNowTicketCreateRequest(
data=ServiceNowTicketCreateData(
attributes=ServiceNowTicketCreateAttributes(
assignment_group="IT Support",
instance_name="my-instance",
),
type=ServiceNowTicketResourceType.TICKETS,
),
)

configuration = Configuration()
configuration.unstable_operations["create_case_service_now_ticket"] = True
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
api_instance.create_case_service_now_ticket(case_id="case_id", body=body)
24 changes: 24 additions & 0 deletions examples/v2/case-management/LinkIncident.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
"""
Link incident to case returns "Created" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
from datadog_api_client.v2.model.incident_relationship_data import IncidentRelationshipData
from datadog_api_client.v2.model.incident_resource_type import IncidentResourceType
from datadog_api_client.v2.model.relationship_to_incident_request import RelationshipToIncidentRequest

body = RelationshipToIncidentRequest(
data=IncidentRelationshipData(
id="00000000-0000-0000-0000-000000000000",
type=IncidentResourceType.INCIDENTS,
),
)

configuration = Configuration()
configuration.unstable_operations["link_incident"] = True
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
response = api_instance.link_incident(case_id="case_id", body=body)

print(response)
25 changes: 25 additions & 0 deletions examples/v2/case-management/LinkJiraIssueToCase.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
"""
Link existing Jira issue to case returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
from datadog_api_client.v2.model.jira_issue_link_attributes import JiraIssueLinkAttributes
from datadog_api_client.v2.model.jira_issue_link_data import JiraIssueLinkData
from datadog_api_client.v2.model.jira_issue_link_request import JiraIssueLinkRequest
from datadog_api_client.v2.model.jira_issue_resource_type import JiraIssueResourceType

body = JiraIssueLinkRequest(
data=JiraIssueLinkData(
attributes=JiraIssueLinkAttributes(
jira_issue_url="https://jira.example.com/browse/PROJ-123",
),
type=JiraIssueResourceType.ISSUES,
),
)

configuration = Configuration()
configuration.unstable_operations["link_jira_issue_to_case"] = True
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
api_instance.link_jira_issue_to_case(case_id="case_id", body=body)
24 changes: 24 additions & 0 deletions examples/v2/case-management/MoveCaseToProject.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
"""
Update case project returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
from datadog_api_client.v2.model.project_relationship import ProjectRelationship
from datadog_api_client.v2.model.project_relationship_data import ProjectRelationshipData
from datadog_api_client.v2.model.project_resource_type import ProjectResourceType

body = ProjectRelationship(
data=ProjectRelationshipData(
id="e555e290-ed65-49bd-ae18-8acbfcf18db7",
type=ProjectResourceType.PROJECT,
),
)

configuration = Configuration()
configuration.unstable_operations["move_case_to_project"] = True
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
response = api_instance.move_case_to_project(case_id="case_id", body=body)

print(response)
14 changes: 14 additions & 0 deletions examples/v2/case-management/UnlinkJiraIssue.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"""
Remove Jira issue link from case returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi

configuration = Configuration()
configuration.unstable_operations["unlink_jira_issue"] = True
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
api_instance.unlink_jira_issue(
case_id="case_id",
)
7 changes: 7 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 @@ -266,6 +266,13 @@ def __init__(
"v2.get_open_api": False,
"v2.list_apis": False,
"v2.update_open_api": False,
"v2.create_case_jira_issue": False,
"v2.create_case_notebook": False,
"v2.create_case_service_now_ticket": False,
"v2.link_incident": False,
"v2.link_jira_issue_to_case": False,
"v2.move_case_to_project": False,
"v2.unlink_jira_issue": False,
"v2.cancel_threat_hunting_job": False,
"v2.convert_job_result_to_signal": False,
"v2.delete_threat_hunting_job": False,
Expand Down
Loading