Skip to content

Commit ae347d6

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add OpenAPI spec for incident user-defined fields config endpoints (#3327)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 818b278 commit ae347d6

30 files changed

+2883
-0
lines changed

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 863 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14298,13 +14298,139 @@ datadog\_api\_client.v2.model.incident\_user\_data module
1429814298
:members:
1429914299
:show-inheritance:
1430014300

14301+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_attributes\_create\_request module
14302+
------------------------------------------------------------------------------------------------
14303+
14304+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_attributes_create_request
14305+
:members:
14306+
:show-inheritance:
14307+
14308+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_attributes\_response module
14309+
-----------------------------------------------------------------------------------------
14310+
14311+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_attributes_response
14312+
:members:
14313+
:show-inheritance:
14314+
14315+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_attributes\_update\_request module
14316+
------------------------------------------------------------------------------------------------
14317+
14318+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_attributes_update_request
14319+
:members:
14320+
:show-inheritance:
14321+
14322+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_category module
14323+
-----------------------------------------------------------------------------
14324+
14325+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_category
14326+
:members:
14327+
:show-inheritance:
14328+
14329+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_collected module
14330+
------------------------------------------------------------------------------
14331+
14332+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_collected
14333+
:members:
14334+
:show-inheritance:
14335+
14336+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_create\_data module
14337+
---------------------------------------------------------------------------------
14338+
14339+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_create_data
14340+
:members:
14341+
:show-inheritance:
14342+
14343+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_create\_relationships module
14344+
------------------------------------------------------------------------------------------
14345+
14346+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_create_relationships
14347+
:members:
14348+
:show-inheritance:
14349+
14350+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_create\_request module
14351+
------------------------------------------------------------------------------------
14352+
14353+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_create_request
14354+
:members:
14355+
:show-inheritance:
14356+
14357+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_field\_type module
14358+
--------------------------------------------------------------------------------
14359+
14360+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_field_type
14361+
:members:
14362+
:show-inheritance:
14363+
14364+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_list\_meta module
14365+
-------------------------------------------------------------------------------
14366+
14367+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_list_meta
14368+
:members:
14369+
:show-inheritance:
14370+
14371+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_list\_response module
14372+
-----------------------------------------------------------------------------------
14373+
14374+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_list_response
14375+
:members:
14376+
:show-inheritance:
14377+
14378+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_metadata module
14379+
-----------------------------------------------------------------------------
14380+
14381+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_metadata
14382+
:members:
14383+
:show-inheritance:
14384+
14385+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_relationships module
14386+
----------------------------------------------------------------------------------
14387+
14388+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_relationships
14389+
:members:
14390+
:show-inheritance:
14391+
14392+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_response module
14393+
-----------------------------------------------------------------------------
14394+
14395+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_response
14396+
:members:
14397+
:show-inheritance:
14398+
14399+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_response\_data module
14400+
-----------------------------------------------------------------------------------
14401+
14402+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_response_data
14403+
:members:
14404+
:show-inheritance:
14405+
1430114406
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_type module
1430214407
-------------------------------------------------------------------------
1430314408

1430414409
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_type
1430514410
:members:
1430614411
:show-inheritance:
1430714412

14413+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_update\_data module
14414+
---------------------------------------------------------------------------------
14415+
14416+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_update_data
14417+
:members:
14418+
:show-inheritance:
14419+
14420+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_update\_request module
14421+
------------------------------------------------------------------------------------
14422+
14423+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_update_request
14424+
:members:
14425+
:show-inheritance:
14426+
14427+
datadog\_api\_client.v2.model.incident\_user\_defined\_field\_valid\_value module
14428+
---------------------------------------------------------------------------------
14429+
14430+
.. automodule:: datadog_api_client.v2.model.incident_user_defined_field_valid_value
14431+
:members:
14432+
:show-inheritance:
14433+
1430814434
datadog\_api\_client.v2.model.incidents\_response module
1430914435
--------------------------------------------------------
1431014436

‎examples/v2/incidents/CreateIncidentUserDefinedField.py‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
"""
2+
Create an incident user-defined field returns "CREATED" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.incidents_api import IncidentsApi
7+
from datadog_api_client.v2.model.incident_type_type import IncidentTypeType
8+
from datadog_api_client.v2.model.incident_user_defined_field_attributes_create_request import (
9+
IncidentUserDefinedFieldAttributesCreateRequest,
10+
)
11+
from datadog_api_client.v2.model.incident_user_defined_field_category import IncidentUserDefinedFieldCategory
12+
from datadog_api_client.v2.model.incident_user_defined_field_collected import IncidentUserDefinedFieldCollected
13+
from datadog_api_client.v2.model.incident_user_defined_field_create_data import IncidentUserDefinedFieldCreateData
14+
from datadog_api_client.v2.model.incident_user_defined_field_create_relationships import (
15+
IncidentUserDefinedFieldCreateRelationships,
16+
)
17+
from datadog_api_client.v2.model.incident_user_defined_field_create_request import IncidentUserDefinedFieldCreateRequest
18+
from datadog_api_client.v2.model.incident_user_defined_field_field_type import IncidentUserDefinedFieldFieldType
19+
from datadog_api_client.v2.model.incident_user_defined_field_type import IncidentUserDefinedFieldType
20+
from datadog_api_client.v2.model.incident_user_defined_field_valid_value import IncidentUserDefinedFieldValidValue
21+
from datadog_api_client.v2.model.relationship_to_incident_type import RelationshipToIncidentType
22+
from datadog_api_client.v2.model.relationship_to_incident_type_data import RelationshipToIncidentTypeData
23+
24+
body = IncidentUserDefinedFieldCreateRequest(
25+
data=IncidentUserDefinedFieldCreateData(
26+
attributes=IncidentUserDefinedFieldAttributesCreateRequest(
27+
category=IncidentUserDefinedFieldCategory.WHAT_HAPPENED,
28+
collected=IncidentUserDefinedFieldCollected.ACTIVE,
29+
default_value="critical",
30+
display_name="Root Cause",
31+
name="root_cause",
32+
ordinal="1.5",
33+
required=False,
34+
tag_key="datacenter",
35+
type=IncidentUserDefinedFieldFieldType.TEXTBOX,
36+
valid_values=[
37+
IncidentUserDefinedFieldValidValue(
38+
description="A critical severity incident.",
39+
display_name="Critical",
40+
short_description="Critical",
41+
value="critical",
42+
),
43+
],
44+
),
45+
relationships=IncidentUserDefinedFieldCreateRelationships(
46+
incident_type=RelationshipToIncidentType(
47+
data=RelationshipToIncidentTypeData(
48+
id="00000000-0000-0000-0000-000000000000",
49+
type=IncidentTypeType.INCIDENT_TYPES,
50+
),
51+
),
52+
),
53+
type=IncidentUserDefinedFieldType.USER_DEFINED_FIELD,
54+
),
55+
)
56+
57+
configuration = Configuration()
58+
configuration.unstable_operations["create_incident_user_defined_field"] = True
59+
with ApiClient(configuration) as api_client:
60+
api_instance = IncidentsApi(api_client)
61+
response = api_instance.create_incident_user_defined_field(body=body)
62+
63+
print(response)

‎examples/v2/incidents/DeleteIncidentUserDefinedField.py‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"""
2+
Delete an incident user-defined field returns "No Content" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.incidents_api import IncidentsApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["delete_incident_user_defined_field"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = IncidentsApi(api_client)
12+
api_instance.delete_incident_user_defined_field(
13+
field_id="00000000-0000-0000-0000-000000000000",
14+
)

‎examples/v2/incidents/GetIncidentUserDefinedField.py‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
"""
2+
Get an incident user-defined field returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.incidents_api import IncidentsApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["get_incident_user_defined_field"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = IncidentsApi(api_client)
12+
response = api_instance.get_incident_user_defined_field(
13+
field_id="00000000-0000-0000-0000-000000000000",
14+
)
15+
16+
print(response)

‎examples/v2/incidents/ListIncidentUserDefinedFields.py‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"""
2+
Get a list of incident user-defined fields returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.incidents_api import IncidentsApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["list_incident_user_defined_fields"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = IncidentsApi(api_client)
12+
response = api_instance.list_incident_user_defined_fields()
13+
14+
print(response)

‎examples/v2/incidents/UpdateIncidentUserDefinedField.py‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
"""
2+
Update an incident user-defined field returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.incidents_api import IncidentsApi
7+
from datadog_api_client.v2.model.incident_user_defined_field_attributes_update_request import (
8+
IncidentUserDefinedFieldAttributesUpdateRequest,
9+
)
10+
from datadog_api_client.v2.model.incident_user_defined_field_category import IncidentUserDefinedFieldCategory
11+
from datadog_api_client.v2.model.incident_user_defined_field_collected import IncidentUserDefinedFieldCollected
12+
from datadog_api_client.v2.model.incident_user_defined_field_type import IncidentUserDefinedFieldType
13+
from datadog_api_client.v2.model.incident_user_defined_field_update_data import IncidentUserDefinedFieldUpdateData
14+
from datadog_api_client.v2.model.incident_user_defined_field_update_request import IncidentUserDefinedFieldUpdateRequest
15+
from datadog_api_client.v2.model.incident_user_defined_field_valid_value import IncidentUserDefinedFieldValidValue
16+
17+
body = IncidentUserDefinedFieldUpdateRequest(
18+
data=IncidentUserDefinedFieldUpdateData(
19+
attributes=IncidentUserDefinedFieldAttributesUpdateRequest(
20+
category=IncidentUserDefinedFieldCategory.WHAT_HAPPENED,
21+
collected=IncidentUserDefinedFieldCollected.ACTIVE,
22+
default_value="critical",
23+
display_name="Root Cause",
24+
ordinal="1.5",
25+
required=False,
26+
valid_values=[
27+
IncidentUserDefinedFieldValidValue(
28+
description="A critical severity incident.",
29+
display_name="Critical",
30+
short_description="Critical",
31+
value="critical",
32+
),
33+
],
34+
),
35+
id="00000000-0000-0000-0000-000000000000",
36+
type=IncidentUserDefinedFieldType.USER_DEFINED_FIELD,
37+
),
38+
)
39+
40+
configuration = Configuration()
41+
configuration.unstable_operations["update_incident_user_defined_field"] = True
42+
with ApiClient(configuration) as api_client:
43+
api_instance = IncidentsApi(api_client)
44+
response = api_instance.update_incident_user_defined_field(
45+
field_id="00000000-0000-0000-0000-000000000000", body=body
46+
)
47+
48+
print(response)

‎src/datadog_api_client/configuration.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -344,6 +344,7 @@ def __init__(
344344
"v2.create_incident_postmortem_template": False,
345345
"v2.create_incident_todo": False,
346346
"v2.create_incident_type": False,
347+
"v2.create_incident_user_defined_field": False,
347348
"v2.delete_global_incident_handle": False,
348349
"v2.delete_incident": False,
349350
"v2.delete_incident_attachment": False,
@@ -353,6 +354,7 @@ def __init__(
353354
"v2.delete_incident_postmortem_template": False,
354355
"v2.delete_incident_todo": False,
355356
"v2.delete_incident_type": False,
357+
"v2.delete_incident_user_defined_field": False,
356358
"v2.get_global_incident_settings": False,
357359
"v2.get_incident": False,
358360
"v2.get_incident_integration": False,
@@ -361,6 +363,7 @@ def __init__(
361363
"v2.get_incident_postmortem_template": False,
362364
"v2.get_incident_todo": False,
363365
"v2.get_incident_type": False,
366+
"v2.get_incident_user_defined_field": False,
364367
"v2.import_incident": False,
365368
"v2.list_global_incident_handles": False,
366369
"v2.list_incident_attachments": False,
@@ -371,6 +374,7 @@ def __init__(
371374
"v2.list_incidents": False,
372375
"v2.list_incident_todos": False,
373376
"v2.list_incident_types": False,
377+
"v2.list_incident_user_defined_fields": False,
374378
"v2.search_incidents": False,
375379
"v2.update_global_incident_handle": False,
376380
"v2.update_global_incident_settings": False,
@@ -382,6 +386,7 @@ def __init__(
382386
"v2.update_incident_postmortem_template": False,
383387
"v2.update_incident_todo": False,
384388
"v2.update_incident_type": False,
389+
"v2.update_incident_user_defined_field": False,
385390
"v2.create_aws_account_ccm_config": False,
386391
"v2.delete_aws_account_ccm_config": False,
387392
"v2.get_aws_account_ccm_config": False,

0 commit comments

Comments
 (0)