Skip to content

Add OpenAPI spec for incident user-defined fields config endpoints #3327

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 spec for incident user-defined fields config endpoints #3327

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

Large diffs are not rendered by default.

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 @@ -13997,13 +13997,146 @@ datadog\_api\_client.v2.model.incident\_user\_data module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_attributes\_create\_request module
------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_attributes\_response module
-----------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_attributes\_update\_request module
------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_category module
-----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_collected module
------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_create\_data module
---------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_create\_relationships module
------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_create\_request module
------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_field\_type module
--------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_import\_request module
------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_list\_meta module
-------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_list\_response module
-----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_metadata module
-----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_relationships module
----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_response module
-----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_response\_data module
-----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_type module
-------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_update\_data module
---------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_update\_request module
------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incident\_user\_defined\_field\_valid\_value module
---------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.incidents\_response module
--------------------------------------------------------

Expand Down
63 changes: 63 additions & 0 deletions examples/v2/incidents/CreateIncidentUserDefinedField.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
"""
Create an incident user-defined field returns "CREATED" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi
from datadog_api_client.v2.model.incident_type_type import IncidentTypeType
from datadog_api_client.v2.model.incident_user_defined_field_attributes_create_request import (
IncidentUserDefinedFieldAttributesCreateRequest,
)
from datadog_api_client.v2.model.incident_user_defined_field_category import IncidentUserDefinedFieldCategory
from datadog_api_client.v2.model.incident_user_defined_field_collected import IncidentUserDefinedFieldCollected
from datadog_api_client.v2.model.incident_user_defined_field_create_data import IncidentUserDefinedFieldCreateData
from datadog_api_client.v2.model.incident_user_defined_field_create_relationships import (
IncidentUserDefinedFieldCreateRelationships,
)
from datadog_api_client.v2.model.incident_user_defined_field_create_request import IncidentUserDefinedFieldCreateRequest
from datadog_api_client.v2.model.incident_user_defined_field_field_type import IncidentUserDefinedFieldFieldType
from datadog_api_client.v2.model.incident_user_defined_field_type import IncidentUserDefinedFieldType
from datadog_api_client.v2.model.incident_user_defined_field_valid_value import IncidentUserDefinedFieldValidValue
from datadog_api_client.v2.model.relationship_to_incident_type import RelationshipToIncidentType
from datadog_api_client.v2.model.relationship_to_incident_type_data import RelationshipToIncidentTypeData

body = IncidentUserDefinedFieldCreateRequest(
data=IncidentUserDefinedFieldCreateData(
attributes=IncidentUserDefinedFieldAttributesCreateRequest(
category=IncidentUserDefinedFieldCategory.WHAT_HAPPENED,
collected=IncidentUserDefinedFieldCollected.ACTIVE,
default_value="critical",
display_name="Root Cause",
name="root_cause",
ordinal="1.5",
required=False,
tag_key="datacenter",
type=IncidentUserDefinedFieldFieldType.TEXTBOX,
valid_values=[
IncidentUserDefinedFieldValidValue(
description="A critical severity incident.",
display_name="Critical",
short_description="Critical",
value="critical",
),
],
),
relationships=IncidentUserDefinedFieldCreateRelationships(
incident_type=RelationshipToIncidentType(
data=RelationshipToIncidentTypeData(
id="00000000-0000-0000-0000-000000000000",
type=IncidentTypeType.INCIDENT_TYPES,
),
),
),
type=IncidentUserDefinedFieldType.USER_DEFINED_FIELD,
),
)

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

print(response)
14 changes: 14 additions & 0 deletions examples/v2/incidents/DeleteIncidentUserDefinedField.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"""
Delete an incident user-defined field returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi

configuration = Configuration()
configuration.unstable_operations["delete_incident_user_defined_field"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
api_instance.delete_incident_user_defined_field(
field_id="00000000-0000-0000-0000-000000000000",
)
16 changes: 16 additions & 0 deletions examples/v2/incidents/GetIncidentUserDefinedField.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Get an incident user-defined field returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi

configuration = Configuration()
configuration.unstable_operations["get_incident_user_defined_field"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
response = api_instance.get_incident_user_defined_field(
field_id="00000000-0000-0000-0000-000000000000",
)

print(response)
16 changes: 16 additions & 0 deletions examples/v2/incidents/ImportIncidentUserDefinedFieldValues.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Import values for an incident user-defined field returns "CREATED" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi

configuration = Configuration()
configuration.unstable_operations["import_incident_user_defined_field_values"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
response = api_instance.import_incident_user_defined_field_values(
field_id="00000000-0000-0000-0000-000000000000",
)

print(response)
14 changes: 14 additions & 0 deletions examples/v2/incidents/ListIncidentUserDefinedFields.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"""
Get a list of incident user-defined fields returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi

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

print(response)
48 changes: 48 additions & 0 deletions examples/v2/incidents/UpdateIncidentUserDefinedField.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
"""
Update an incident user-defined field returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi
from datadog_api_client.v2.model.incident_user_defined_field_attributes_update_request import (
IncidentUserDefinedFieldAttributesUpdateRequest,
)
from datadog_api_client.v2.model.incident_user_defined_field_category import IncidentUserDefinedFieldCategory
from datadog_api_client.v2.model.incident_user_defined_field_collected import IncidentUserDefinedFieldCollected
from datadog_api_client.v2.model.incident_user_defined_field_type import IncidentUserDefinedFieldType
from datadog_api_client.v2.model.incident_user_defined_field_update_data import IncidentUserDefinedFieldUpdateData
from datadog_api_client.v2.model.incident_user_defined_field_update_request import IncidentUserDefinedFieldUpdateRequest
from datadog_api_client.v2.model.incident_user_defined_field_valid_value import IncidentUserDefinedFieldValidValue

body = IncidentUserDefinedFieldUpdateRequest(
data=IncidentUserDefinedFieldUpdateData(
attributes=IncidentUserDefinedFieldAttributesUpdateRequest(
category=IncidentUserDefinedFieldCategory.WHAT_HAPPENED,
collected=IncidentUserDefinedFieldCollected.ACTIVE,
default_value="critical",
display_name="Root Cause",
ordinal="1.5",
required=False,
valid_values=[
IncidentUserDefinedFieldValidValue(
description="A critical severity incident.",
display_name="Critical",
short_description="Critical",
value="critical",
),
],
),
id="00000000-0000-0000-0000-000000000000",
type=IncidentUserDefinedFieldType.USER_DEFINED_FIELD,
),
)

configuration = Configuration()
configuration.unstable_operations["update_incident_user_defined_field"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
response = api_instance.update_incident_user_defined_field(
field_id="00000000-0000-0000-0000-000000000000", body=body
)

print(response)
6 changes: 6 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 @@ -336,6 +336,7 @@ def __init__(
"v2.create_incident_postmortem_template": False,
"v2.create_incident_todo": False,
"v2.create_incident_type": False,
"v2.create_incident_user_defined_field": False,
"v2.delete_global_incident_handle": False,
"v2.delete_incident": False,
"v2.delete_incident_attachment": False,
Expand All @@ -345,6 +346,7 @@ def __init__(
"v2.delete_incident_postmortem_template": False,
"v2.delete_incident_todo": False,
"v2.delete_incident_type": False,
"v2.delete_incident_user_defined_field": False,
"v2.get_global_incident_settings": False,
"v2.get_incident": False,
"v2.get_incident_integration": False,
Expand All @@ -353,7 +355,9 @@ def __init__(
"v2.get_incident_postmortem_template": False,
"v2.get_incident_todo": False,
"v2.get_incident_type": False,
"v2.get_incident_user_defined_field": False,
"v2.import_incident": False,
"v2.import_incident_user_defined_field_values": False,
"v2.list_global_incident_handles": False,
"v2.list_incident_attachments": False,
"v2.list_incident_integrations": False,
Expand All @@ -363,6 +367,7 @@ def __init__(
"v2.list_incidents": False,
"v2.list_incident_todos": False,
"v2.list_incident_types": False,
"v2.list_incident_user_defined_fields": False,
"v2.search_incidents": False,
"v2.update_global_incident_handle": False,
"v2.update_global_incident_settings": False,
Expand All @@ -374,6 +379,7 @@ def __init__(
"v2.update_incident_postmortem_template": False,
"v2.update_incident_todo": False,
"v2.update_incident_type": False,
"v2.update_incident_user_defined_field": False,
"v2.create_aws_account_ccm_config": False,
"v2.delete_aws_account_ccm_config": False,
"v2.get_aws_account_ccm_config": False,
Expand Down
Loading
Loading