Skip to content

Commit c829120

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Document multiple case-management endpoints (#2759)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent f2823ff commit c829120

File tree

171 files changed

+7384
-115
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

171 files changed

+7384
-115
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 888 additions & 3 deletions
Large diffs are not rendered by default.

docs/datadog_api_client.v2.api.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,20 @@ datadog\_api\_client.v2.api.case\_management\_api module
8888
:members:
8989
:show-inheritance:
9090

91+
datadog\_api\_client.v2.api.case\_management\_attribute\_api module
92+
-------------------------------------------------------------------
93+
94+
.. automodule:: datadog_api_client.v2.api.case_management_attribute_api
95+
:members:
96+
:show-inheritance:
97+
98+
datadog\_api\_client.v2.api.case\_management\_type\_api module
99+
--------------------------------------------------------------
100+
101+
.. automodule:: datadog_api_client.v2.api.case_management_type_api
102+
:members:
103+
:show-inheritance:
104+
91105
datadog\_api\_client.v2.api.ci\_visibility\_pipelines\_api module
92106
-----------------------------------------------------------------
93107

docs/datadog_api_client.v2.model.rst

Lines changed: 280 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2566,6 +2566,27 @@ datadog\_api\_client.v2.model.case\_attributes module
25662566
:members:
25672567
:show-inheritance:
25682568

2569+
datadog\_api\_client.v2.model.case\_comment module
2570+
--------------------------------------------------
2571+
2572+
.. automodule:: datadog_api_client.v2.model.case_comment
2573+
:members:
2574+
:show-inheritance:
2575+
2576+
datadog\_api\_client.v2.model.case\_comment\_attributes module
2577+
--------------------------------------------------------------
2578+
2579+
.. automodule:: datadog_api_client.v2.model.case_comment_attributes
2580+
:members:
2581+
:show-inheritance:
2582+
2583+
datadog\_api\_client.v2.model.case\_comment\_request module
2584+
-----------------------------------------------------------
2585+
2586+
.. automodule:: datadog_api_client.v2.model.case_comment_request
2587+
:members:
2588+
:show-inheritance:
2589+
25692590
datadog\_api\_client.v2.model.case\_create module
25702591
-------------------------------------------------
25712592

@@ -2678,6 +2699,55 @@ datadog\_api\_client.v2.model.case\_type module
26782699
:members:
26792700
:show-inheritance:
26802701

2702+
datadog\_api\_client.v2.model.case\_type\_create module
2703+
-------------------------------------------------------
2704+
2705+
.. automodule:: datadog_api_client.v2.model.case_type_create
2706+
:members:
2707+
:show-inheritance:
2708+
2709+
datadog\_api\_client.v2.model.case\_type\_create\_request module
2710+
----------------------------------------------------------------
2711+
2712+
.. automodule:: datadog_api_client.v2.model.case_type_create_request
2713+
:members:
2714+
:show-inheritance:
2715+
2716+
datadog\_api\_client.v2.model.case\_type\_resource module
2717+
---------------------------------------------------------
2718+
2719+
.. automodule:: datadog_api_client.v2.model.case_type_resource
2720+
:members:
2721+
:show-inheritance:
2722+
2723+
datadog\_api\_client.v2.model.case\_type\_resource\_attributes module
2724+
---------------------------------------------------------------------
2725+
2726+
.. automodule:: datadog_api_client.v2.model.case_type_resource_attributes
2727+
:members:
2728+
:show-inheritance:
2729+
2730+
datadog\_api\_client.v2.model.case\_type\_resource\_type module
2731+
---------------------------------------------------------------
2732+
2733+
.. automodule:: datadog_api_client.v2.model.case_type_resource_type
2734+
:members:
2735+
:show-inheritance:
2736+
2737+
datadog\_api\_client.v2.model.case\_type\_response module
2738+
---------------------------------------------------------
2739+
2740+
.. automodule:: datadog_api_client.v2.model.case_type_response
2741+
:members:
2742+
:show-inheritance:
2743+
2744+
datadog\_api\_client.v2.model.case\_types\_response module
2745+
----------------------------------------------------------
2746+
2747+
.. automodule:: datadog_api_client.v2.model.case_types_response
2748+
:members:
2749+
:show-inheritance:
2750+
26812751
datadog\_api\_client.v2.model.case\_update\_attributes module
26822752
-------------------------------------------------------------
26832753

@@ -2699,6 +2769,41 @@ datadog\_api\_client.v2.model.case\_update\_attributes\_request module
26992769
:members:
27002770
:show-inheritance:
27012771

2772+
datadog\_api\_client.v2.model.case\_update\_custom\_attribute module
2773+
--------------------------------------------------------------------
2774+
2775+
.. automodule:: datadog_api_client.v2.model.case_update_custom_attribute
2776+
:members:
2777+
:show-inheritance:
2778+
2779+
datadog\_api\_client.v2.model.case\_update\_custom\_attribute\_request module
2780+
-----------------------------------------------------------------------------
2781+
2782+
.. automodule:: datadog_api_client.v2.model.case_update_custom_attribute_request
2783+
:members:
2784+
:show-inheritance:
2785+
2786+
datadog\_api\_client.v2.model.case\_update\_description module
2787+
--------------------------------------------------------------
2788+
2789+
.. automodule:: datadog_api_client.v2.model.case_update_description
2790+
:members:
2791+
:show-inheritance:
2792+
2793+
datadog\_api\_client.v2.model.case\_update\_description\_attributes module
2794+
--------------------------------------------------------------------------
2795+
2796+
.. automodule:: datadog_api_client.v2.model.case_update_description_attributes
2797+
:members:
2798+
:show-inheritance:
2799+
2800+
datadog\_api\_client.v2.model.case\_update\_description\_request module
2801+
-----------------------------------------------------------------------
2802+
2803+
.. automodule:: datadog_api_client.v2.model.case_update_description_request
2804+
:members:
2805+
:show-inheritance:
2806+
27022807
datadog\_api\_client.v2.model.case\_update\_priority module
27032808
-----------------------------------------------------------
27042809

@@ -2741,6 +2846,27 @@ datadog\_api\_client.v2.model.case\_update\_status\_request module
27412846
:members:
27422847
:show-inheritance:
27432848

2849+
datadog\_api\_client.v2.model.case\_update\_title module
2850+
--------------------------------------------------------
2851+
2852+
.. automodule:: datadog_api_client.v2.model.case_update_title
2853+
:members:
2854+
:show-inheritance:
2855+
2856+
datadog\_api\_client.v2.model.case\_update\_title\_attributes module
2857+
--------------------------------------------------------------------
2858+
2859+
.. automodule:: datadog_api_client.v2.model.case_update_title_attributes
2860+
:members:
2861+
:show-inheritance:
2862+
2863+
datadog\_api\_client.v2.model.case\_update\_title\_request module
2864+
-----------------------------------------------------------------
2865+
2866+
.. automodule:: datadog_api_client.v2.model.case_update_title_request
2867+
:members:
2868+
:show-inheritance:
2869+
27442870
datadog\_api\_client.v2.model.cases\_response module
27452871
----------------------------------------------------
27462872

@@ -5184,6 +5310,83 @@ datadog\_api\_client.v2.model.csm\_serverless\_coverage\_analysis\_response modu
51845310
:members:
51855311
:show-inheritance:
51865312

5313+
datadog\_api\_client.v2.model.custom\_attribute\_config module
5314+
--------------------------------------------------------------
5315+
5316+
.. automodule:: datadog_api_client.v2.model.custom_attribute_config
5317+
:members:
5318+
:show-inheritance:
5319+
5320+
datadog\_api\_client.v2.model.custom\_attribute\_config\_attributes\_create module
5321+
----------------------------------------------------------------------------------
5322+
5323+
.. automodule:: datadog_api_client.v2.model.custom_attribute_config_attributes_create
5324+
:members:
5325+
:show-inheritance:
5326+
5327+
datadog\_api\_client.v2.model.custom\_attribute\_config\_create module
5328+
----------------------------------------------------------------------
5329+
5330+
.. automodule:: datadog_api_client.v2.model.custom_attribute_config_create
5331+
:members:
5332+
:show-inheritance:
5333+
5334+
datadog\_api\_client.v2.model.custom\_attribute\_config\_create\_request module
5335+
-------------------------------------------------------------------------------
5336+
5337+
.. automodule:: datadog_api_client.v2.model.custom_attribute_config_create_request
5338+
:members:
5339+
:show-inheritance:
5340+
5341+
datadog\_api\_client.v2.model.custom\_attribute\_config\_resource\_attributes module
5342+
------------------------------------------------------------------------------------
5343+
5344+
.. automodule:: datadog_api_client.v2.model.custom_attribute_config_resource_attributes
5345+
:members:
5346+
:show-inheritance:
5347+
5348+
datadog\_api\_client.v2.model.custom\_attribute\_config\_resource\_type module
5349+
------------------------------------------------------------------------------
5350+
5351+
.. automodule:: datadog_api_client.v2.model.custom_attribute_config_resource_type
5352+
:members:
5353+
:show-inheritance:
5354+
5355+
datadog\_api\_client.v2.model.custom\_attribute\_config\_response module
5356+
------------------------------------------------------------------------
5357+
5358+
.. automodule:: datadog_api_client.v2.model.custom_attribute_config_response
5359+
:members:
5360+
:show-inheritance:
5361+
5362+
datadog\_api\_client.v2.model.custom\_attribute\_configs\_response module
5363+
-------------------------------------------------------------------------
5364+
5365+
.. automodule:: datadog_api_client.v2.model.custom_attribute_configs_response
5366+
:members:
5367+
:show-inheritance:
5368+
5369+
datadog\_api\_client.v2.model.custom\_attribute\_type module
5370+
------------------------------------------------------------
5371+
5372+
.. automodule:: datadog_api_client.v2.model.custom_attribute_type
5373+
:members:
5374+
:show-inheritance:
5375+
5376+
datadog\_api\_client.v2.model.custom\_attribute\_value module
5377+
-------------------------------------------------------------
5378+
5379+
.. automodule:: datadog_api_client.v2.model.custom_attribute_value
5380+
:members:
5381+
:show-inheritance:
5382+
5383+
datadog\_api\_client.v2.model.custom\_attribute\_values\_union module
5384+
---------------------------------------------------------------------
5385+
5386+
.. automodule:: datadog_api_client.v2.model.custom_attribute_values_union
5387+
:members:
5388+
:show-inheritance:
5389+
51875390
datadog\_api\_client.v2.model.custom\_connection module
51885391
-------------------------------------------------------
51895392

@@ -21774,6 +21977,83 @@ datadog\_api\_client.v2.model.time\_restrictions module
2177421977
:members:
2177521978
:show-inheritance:
2177621979

21980+
datadog\_api\_client.v2.model.timeline\_cell module
21981+
---------------------------------------------------
21982+
21983+
.. automodule:: datadog_api_client.v2.model.timeline_cell
21984+
:members:
21985+
:show-inheritance:
21986+
21987+
datadog\_api\_client.v2.model.timeline\_cell\_author module
21988+
-----------------------------------------------------------
21989+
21990+
.. automodule:: datadog_api_client.v2.model.timeline_cell_author
21991+
:members:
21992+
:show-inheritance:
21993+
21994+
datadog\_api\_client.v2.model.timeline\_cell\_author\_user module
21995+
-----------------------------------------------------------------
21996+
21997+
.. automodule:: datadog_api_client.v2.model.timeline_cell_author_user
21998+
:members:
21999+
:show-inheritance:
22000+
22001+
datadog\_api\_client.v2.model.timeline\_cell\_author\_user\_content module
22002+
--------------------------------------------------------------------------
22003+
22004+
.. automodule:: datadog_api_client.v2.model.timeline_cell_author_user_content
22005+
:members:
22006+
:show-inheritance:
22007+
22008+
datadog\_api\_client.v2.model.timeline\_cell\_author\_user\_type module
22009+
-----------------------------------------------------------------------
22010+
22011+
.. automodule:: datadog_api_client.v2.model.timeline_cell_author_user_type
22012+
:members:
22013+
:show-inheritance:
22014+
22015+
datadog\_api\_client.v2.model.timeline\_cell\_content module
22016+
------------------------------------------------------------
22017+
22018+
.. automodule:: datadog_api_client.v2.model.timeline_cell_content
22019+
:members:
22020+
:show-inheritance:
22021+
22022+
datadog\_api\_client.v2.model.timeline\_cell\_content\_comment module
22023+
---------------------------------------------------------------------
22024+
22025+
.. automodule:: datadog_api_client.v2.model.timeline_cell_content_comment
22026+
:members:
22027+
:show-inheritance:
22028+
22029+
datadog\_api\_client.v2.model.timeline\_cell\_resource module
22030+
-------------------------------------------------------------
22031+
22032+
.. automodule:: datadog_api_client.v2.model.timeline_cell_resource
22033+
:members:
22034+
:show-inheritance:
22035+
22036+
datadog\_api\_client.v2.model.timeline\_cell\_resource\_type module
22037+
-------------------------------------------------------------------
22038+
22039+
.. automodule:: datadog_api_client.v2.model.timeline_cell_resource_type
22040+
:members:
22041+
:show-inheritance:
22042+
22043+
datadog\_api\_client.v2.model.timeline\_cell\_type module
22044+
---------------------------------------------------------
22045+
22046+
.. automodule:: datadog_api_client.v2.model.timeline_cell_type
22047+
:members:
22048+
:show-inheritance:
22049+
22050+
datadog\_api\_client.v2.model.timeline\_response module
22051+
-------------------------------------------------------
22052+
22053+
.. automodule:: datadog_api_client.v2.model.timeline_response
22054+
:members:
22055+
:show-inheritance:
22056+
2177722057
datadog\_api\_client.v2.model.timeseries\_formula\_query\_request module
2177822058
------------------------------------------------------------------------
2177922059

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
"""
2+
Create custom attribute config for a case type returns "CREATED" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.case_management_attribute_api import CaseManagementAttributeApi
8+
from datadog_api_client.v2.model.custom_attribute_config_attributes_create import CustomAttributeConfigAttributesCreate
9+
from datadog_api_client.v2.model.custom_attribute_config_create import CustomAttributeConfigCreate
10+
from datadog_api_client.v2.model.custom_attribute_config_create_request import CustomAttributeConfigCreateRequest
11+
from datadog_api_client.v2.model.custom_attribute_config_resource_type import CustomAttributeConfigResourceType
12+
from datadog_api_client.v2.model.custom_attribute_type import CustomAttributeType
13+
14+
# there is a valid "case_type" in the system
15+
CASE_TYPE_ID = environ["CASE_TYPE_ID"]
16+
17+
body = CustomAttributeConfigCreateRequest(
18+
data=CustomAttributeConfigCreate(
19+
attributes=CustomAttributeConfigAttributesCreate(
20+
display_name="AWS Region 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
21+
is_multi=True,
22+
key="region_d9fe56bc9274fbb6",
23+
type=CustomAttributeType.NUMBER,
24+
),
25+
type=CustomAttributeConfigResourceType.CUSTOM_ATTRIBUTE,
26+
),
27+
)
28+
29+
configuration = Configuration()
30+
with ApiClient(configuration) as api_client:
31+
api_instance = CaseManagementAttributeApi(api_client)
32+
response = api_instance.create_custom_attribute_config(case_type_id=CASE_TYPE_ID, body=body)
33+
34+
print(response)
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
"""
2+
Delete custom attributes config returns "No Content" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.case_management_attribute_api import CaseManagementAttributeApi
8+
9+
# there is a valid "case_type" in the system
10+
CASE_TYPE_ID = environ["CASE_TYPE_ID"]
11+
12+
# there is a valid "custom_attribute" in the system
13+
CUSTOM_ATTRIBUTE_ID = environ["CUSTOM_ATTRIBUTE_ID"]
14+
15+
configuration = Configuration()
16+
with ApiClient(configuration) as api_client:
17+
api_instance = CaseManagementAttributeApi(api_client)
18+
api_instance.delete_custom_attribute_config(
19+
case_type_id=CASE_TYPE_ID,
20+
custom_attribute_id=CUSTOM_ATTRIBUTE_ID,
21+
)

0 commit comments

Comments
 (0)