Skip to content

Add OpenAPI specification for collab-general service #3094

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

Merged
api-clients-generation-pipeline merged 1 commit into from
Jan 20, 2026
Merged

Add OpenAPI specification for collab-general service #3094

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

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions docs/datadog_api_client.v2.api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,13 @@ datadog\_api\_client.v2.api.ip\_allowlist\_api module
:members:
:show-inheritance:

datadog\_api\_client.v2.api.jira\_integration\_api module
---------------------------------------------------------

.. automodule:: datadog_api_client.v2.api.jira_integration_api
:members:
:show-inheritance:

datadog\_api\_client.v2.api.key\_management\_api module
-------------------------------------------------------

Expand Down
133 changes: 133 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 @@ -12653,6 +12653,48 @@ datadog\_api\_client.v2.model.item\_api\_payload\_meta\_schema\_field module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.jira\_account\_attributes module
--------------------------------------------------------------

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

datadog\_api\_client.v2.model.jira\_account\_data module
--------------------------------------------------------

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

datadog\_api\_client.v2.model.jira\_account\_relationship module
----------------------------------------------------------------

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

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

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

datadog\_api\_client.v2.model.jira\_accounts\_meta module
---------------------------------------------------------

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

datadog\_api\_client.v2.model.jira\_accounts\_response module
-------------------------------------------------------------

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

datadog\_api\_client.v2.model.jira\_integration\_metadata module
----------------------------------------------------------------

Expand Down Expand Up @@ -12681,6 +12723,97 @@ datadog\_api\_client.v2.model.jira\_issue\_result module
:members:
:show-inheritance:

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

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

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

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

datadog\_api\_client.v2.model.jira\_issue\_template\_create\_request\_attributes\_jira\_account module
------------------------------------------------------------------------------------------------------

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

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

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

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

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

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

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

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

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

datadog\_api\_client.v2.model.jira\_issue\_template\_response module
--------------------------------------------------------------------

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

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

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

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

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

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

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

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

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

datadog\_api\_client.v2.model.jira\_issue\_templates\_response module
---------------------------------------------------------------------

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

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

Expand Down
39 changes: 39 additions & 0 deletions examples/v2/jira-integration/CreateJiraIssueTemplate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
"""
Create Jira issue template returns "Created" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.jira_integration_api import JiraIntegrationApi
from datadog_api_client.v2.model.jira_issue_template_create_request import JiraIssueTemplateCreateRequest
from datadog_api_client.v2.model.jira_issue_template_create_request_attributes import (
JiraIssueTemplateCreateRequestAttributes,
)
from datadog_api_client.v2.model.jira_issue_template_create_request_attributes_jira_account import (
JiraIssueTemplateCreateRequestAttributesJiraAccount,
)
from datadog_api_client.v2.model.jira_issue_template_create_request_data import JiraIssueTemplateCreateRequestData
from datadog_api_client.v2.model.jira_issue_template_type import JiraIssueTemplateType
from uuid import UUID

body = JiraIssueTemplateCreateRequest(
data=JiraIssueTemplateCreateRequestData(
attributes=JiraIssueTemplateCreateRequestAttributes(
fields=dict([("description", "{'payload': 'Test', 'type': 'json'}")]),
issue_type_id="12730",
jira_account=JiraIssueTemplateCreateRequestAttributesJiraAccount(
id=UUID("80f16d40-1fba-486e-b1fc-983e6ca19bec"),
),
name="test-template",
project_id="10772",
),
type=JiraIssueTemplateType.JIRA_ISSUE_TEMPLATE,
),
)

configuration = Configuration()
configuration.unstable_operations["create_jira_issue_template"] = True
with ApiClient(configuration) as api_client:
api_instance = JiraIntegrationApi(api_client)
response = api_instance.create_jira_issue_template(body=body)

print(response)
15 changes: 15 additions & 0 deletions examples/v2/jira-integration/DeleteJiraAccount.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
"""
Delete Jira account returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.jira_integration_api import JiraIntegrationApi
from uuid import UUID

configuration = Configuration()
configuration.unstable_operations["delete_jira_account"] = True
with ApiClient(configuration) as api_client:
api_instance = JiraIntegrationApi(api_client)
api_instance.delete_jira_account(
account_id=UUID("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"),
)
15 changes: 15 additions & 0 deletions examples/v2/jira-integration/DeleteJiraIssueTemplate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
"""
Delete Jira issue template returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.jira_integration_api import JiraIntegrationApi
from uuid import UUID

configuration = Configuration()
configuration.unstable_operations["delete_jira_issue_template"] = True
with ApiClient(configuration) as api_client:
api_instance = JiraIntegrationApi(api_client)
api_instance.delete_jira_issue_template(
issue_template_id=UUID("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"),
)
17 changes: 17 additions & 0 deletions examples/v2/jira-integration/GetJiraIssueTemplate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
"""
Get Jira issue template returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.jira_integration_api import JiraIntegrationApi
from uuid import UUID

configuration = Configuration()
configuration.unstable_operations["get_jira_issue_template"] = True
with ApiClient(configuration) as api_client:
api_instance = JiraIntegrationApi(api_client)
response = api_instance.get_jira_issue_template(
issue_template_id=UUID("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"),
)

print(response)
14 changes: 14 additions & 0 deletions examples/v2/jira-integration/ListJiraAccounts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"""
List Jira accounts returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.jira_integration_api import JiraIntegrationApi

configuration = Configuration()
configuration.unstable_operations["list_jira_accounts"] = True
with ApiClient(configuration) as api_client:
api_instance = JiraIntegrationApi(api_client)
response = api_instance.list_jira_accounts()

print(response)
14 changes: 14 additions & 0 deletions examples/v2/jira-integration/ListJiraIssueTemplates.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"""
List Jira issue templates returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.jira_integration_api import JiraIntegrationApi

configuration = Configuration()
configuration.unstable_operations["list_jira_issue_templates"] = True
with ApiClient(configuration) as api_client:
api_instance = JiraIntegrationApi(api_client)
response = api_instance.list_jira_issue_templates()

print(response)
33 changes: 33 additions & 0 deletions examples/v2/jira-integration/UpdateJiraIssueTemplate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
"""
Update Jira issue template returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.jira_integration_api import JiraIntegrationApi
from datadog_api_client.v2.model.jira_issue_template_type import JiraIssueTemplateType
from datadog_api_client.v2.model.jira_issue_template_update_request import JiraIssueTemplateUpdateRequest
from datadog_api_client.v2.model.jira_issue_template_update_request_attributes import (
JiraIssueTemplateUpdateRequestAttributes,
)
from datadog_api_client.v2.model.jira_issue_template_update_request_data import JiraIssueTemplateUpdateRequestData
from uuid import UUID

body = JiraIssueTemplateUpdateRequest(
data=JiraIssueTemplateUpdateRequestData(
attributes=JiraIssueTemplateUpdateRequestAttributes(
fields=dict([("description", "{'payload': 'Updated Description', 'type': 'json'}")]),
name="test_template_updated",
),
type=JiraIssueTemplateType.JIRA_ISSUE_TEMPLATE,
),
)

configuration = Configuration()
configuration.unstable_operations["update_jira_issue_template"] = True
with ApiClient(configuration) as api_client:
api_instance = JiraIntegrationApi(api_client)
response = api_instance.update_jira_issue_template(
issue_template_id=UUID("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"), body=body
)

print(response)
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 @@ -342,6 +342,13 @@ def __init__(
"v2.update_incident_notification_template": False,
"v2.update_incident_todo": False,
"v2.update_incident_type": False,
"v2.create_jira_issue_template": False,
"v2.delete_jira_account": False,
"v2.delete_jira_issue_template": False,
"v2.get_jira_issue_template": False,
"v2.list_jira_accounts": False,
"v2.list_jira_issue_templates": False,
"v2.update_jira_issue_template": False,
"v2.add_role_to_restriction_query": False,
"v2.create_restriction_query": False,
"v2.delete_restriction_query": False,
Expand Down
Loading