Skip to content

Commit 8471f5b

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Regenerate client from commit 14b6251 of spec repo (#3559)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 2cdd403 commit 8471f5b

43 files changed

Lines changed: 2755 additions & 0 deletions

Some content is hidden

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

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

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

‎docs/datadog_api_client.v2.api.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,13 @@ datadog\_api\_client.v2.api.agentless\_scanning\_api module
2525
:members:
2626
:show-inheritance:
2727

28+
datadog\_api\_client.v2.api.annotations\_api module
29+
---------------------------------------------------
30+
31+
.. automodule:: datadog_api_client.v2.api.annotations_api
32+
:members:
33+
:show-inheritance:
34+
2835
datadog\_api\_client.v2.api.api\_management\_api module
2936
-------------------------------------------------------
3037

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -767,6 +767,41 @@ datadog\_api\_client.v2.model.annotation module
767767
:members:
768768
:show-inheritance:
769769

770+
datadog\_api\_client.v2.model.annotation\_attributes module
771+
-----------------------------------------------------------
772+
773+
.. automodule:: datadog_api_client.v2.model.annotation_attributes
774+
:members:
775+
:show-inheritance:
776+
777+
datadog\_api\_client.v2.model.annotation\_color module
778+
------------------------------------------------------
779+
780+
.. automodule:: datadog_api_client.v2.model.annotation_color
781+
:members:
782+
:show-inheritance:
783+
784+
datadog\_api\_client.v2.model.annotation\_create\_attributes module
785+
-------------------------------------------------------------------
786+
787+
.. automodule:: datadog_api_client.v2.model.annotation_create_attributes
788+
:members:
789+
:show-inheritance:
790+
791+
datadog\_api\_client.v2.model.annotation\_create\_request module
792+
----------------------------------------------------------------
793+
794+
.. automodule:: datadog_api_client.v2.model.annotation_create_request
795+
:members:
796+
:show-inheritance:
797+
798+
datadog\_api\_client.v2.model.annotation\_data module
799+
-----------------------------------------------------
800+
801+
.. automodule:: datadog_api_client.v2.model.annotation_data
802+
:members:
803+
:show-inheritance:
804+
770805
datadog\_api\_client.v2.model.annotation\_display module
771806
--------------------------------------------------------
772807

@@ -781,13 +816,69 @@ datadog\_api\_client.v2.model.annotation\_display\_bounds module
781816
:members:
782817
:show-inheritance:
783818

819+
datadog\_api\_client.v2.model.annotation\_in\_page module
820+
---------------------------------------------------------
821+
822+
.. automodule:: datadog_api_client.v2.model.annotation_in_page
823+
:members:
824+
:show-inheritance:
825+
826+
datadog\_api\_client.v2.model.annotation\_kind module
827+
-----------------------------------------------------
828+
829+
.. automodule:: datadog_api_client.v2.model.annotation_kind
830+
:members:
831+
:show-inheritance:
832+
784833
datadog\_api\_client.v2.model.annotation\_markdown\_text\_annotation module
785834
---------------------------------------------------------------------------
786835

787836
.. automodule:: datadog_api_client.v2.model.annotation_markdown_text_annotation
788837
:members:
789838
:show-inheritance:
790839

840+
datadog\_api\_client.v2.model.annotation\_request\_data module
841+
--------------------------------------------------------------
842+
843+
.. automodule:: datadog_api_client.v2.model.annotation_request_data
844+
:members:
845+
:show-inheritance:
846+
847+
datadog\_api\_client.v2.model.annotation\_response module
848+
---------------------------------------------------------
849+
850+
.. automodule:: datadog_api_client.v2.model.annotation_response
851+
:members:
852+
:show-inheritance:
853+
854+
datadog\_api\_client.v2.model.annotation\_type module
855+
-----------------------------------------------------
856+
857+
.. automodule:: datadog_api_client.v2.model.annotation_type
858+
:members:
859+
:show-inheritance:
860+
861+
datadog\_api\_client.v2.model.annotation\_update\_request module
862+
----------------------------------------------------------------
863+
864+
.. automodule:: datadog_api_client.v2.model.annotation_update_request
865+
:members:
866+
:show-inheritance:
867+
868+
datadog\_api\_client.v2.model.annotations\_in\_page\_map module
869+
---------------------------------------------------------------
870+
871+
.. automodule:: datadog_api_client.v2.model.annotations_in_page_map
872+
:members:
873+
:show-inheritance:
874+
875+
datadog\_api\_client.v2.model.annotations\_response module
876+
----------------------------------------------------------
877+
878+
.. automodule:: datadog_api_client.v2.model.annotations_response
879+
:members:
880+
:show-inheritance:
881+
791882
datadog\_api\_client.v2.model.anonymize\_user\_error module
792883
-----------------------------------------------------------
793884

@@ -27129,6 +27220,34 @@ datadog\_api\_client.v2.model.overwrite\_allocations\_request module
2712927220
:members:
2713027221
:show-inheritance:
2713127222

27223+
datadog\_api\_client.v2.model.page\_annotations\_attributes module
27224+
------------------------------------------------------------------
27225+
27226+
.. automodule:: datadog_api_client.v2.model.page_annotations_attributes
27227+
:members:
27228+
:show-inheritance:
27229+
27230+
datadog\_api\_client.v2.model.page\_annotations\_data module
27231+
------------------------------------------------------------
27232+
27233+
.. automodule:: datadog_api_client.v2.model.page_annotations_data
27234+
:members:
27235+
:show-inheritance:
27236+
27237+
datadog\_api\_client.v2.model.page\_annotations\_response module
27238+
----------------------------------------------------------------
27239+
27240+
.. automodule:: datadog_api_client.v2.model.page_annotations_response
27241+
:members:
27242+
:show-inheritance:
27243+
27244+
datadog\_api\_client.v2.model.page\_annotations\_type module
27245+
------------------------------------------------------------
27246+
27247+
.. automodule:: datadog_api_client.v2.model.page_annotations_type
27248+
:members:
27249+
:show-inheritance:
27250+
2713227251
datadog\_api\_client.v2.model.page\_urgency module
2713327252
--------------------------------------------------
2713427253

@@ -41311,6 +41430,13 @@ datadog\_api\_client.v2.model.weekday module
4131141430
:members:
4131241431
:show-inheritance:
4131341432

41433+
datadog\_api\_client.v2.model.widget\_annotations\_map module
41434+
-------------------------------------------------------------
41435+
41436+
.. automodule:: datadog_api_client.v2.model.widget_annotations_map
41437+
:members:
41438+
:show-inheritance:
41439+
4131441440
datadog\_api\_client.v2.model.widget\_attributes module
4131541441
-------------------------------------------------------
4131641442

‎examples/v2/annotations/CreateAnnotation.py‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
"""
2+
Create an annotation returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.annotations_api import AnnotationsApi
7+
from datadog_api_client.v2.model.annotation_color import AnnotationColor
8+
from datadog_api_client.v2.model.annotation_create_attributes import AnnotationCreateAttributes
9+
from datadog_api_client.v2.model.annotation_create_request import AnnotationCreateRequest
10+
from datadog_api_client.v2.model.annotation_kind import AnnotationKind
11+
from datadog_api_client.v2.model.annotation_request_data import AnnotationRequestData
12+
from datadog_api_client.v2.model.annotation_type import AnnotationType
13+
14+
body = AnnotationCreateRequest(
15+
data=AnnotationRequestData(
16+
attributes=AnnotationCreateAttributes(
17+
color=AnnotationColor.BLUE,
18+
description="Deployed v2.3.1 to production.",
19+
page_id="dashboard:abc-def-xyz",
20+
start_time=1704067200000,
21+
type=AnnotationKind.POINT_IN_TIME,
22+
widget_ids=[
23+
"1234567890",
24+
],
25+
),
26+
type=AnnotationType.ANNOTATION,
27+
),
28+
)
29+
30+
configuration = Configuration()
31+
configuration.unstable_operations["create_annotation"] = True
32+
with ApiClient(configuration) as api_client:
33+
api_instance = AnnotationsApi(api_client)
34+
response = api_instance.create_annotation(body=body)
35+
36+
print(response)

‎examples/v2/annotations/DeleteAnnotation.py‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
"""
2+
Delete an annotation 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.annotations_api import AnnotationsApi
8+
9+
# there is a valid "annotation" in the system
10+
ANNOTATION_DATA_ID = environ["ANNOTATION_DATA_ID"]
11+
12+
configuration = Configuration()
13+
configuration.unstable_operations["delete_annotation"] = True
14+
with ApiClient(configuration) as api_client:
15+
api_instance = AnnotationsApi(api_client)
16+
api_instance.delete_annotation(
17+
annotation_id=ANNOTATION_DATA_ID,
18+
)

‎examples/v2/annotations/GetPageAnnotations.py‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
"""
2+
Get annotations for a page returns "OK" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.annotations_api import AnnotationsApi
8+
9+
# there is a valid "annotation" in the system
10+
ANNOTATION_DATA_ATTRIBUTES_PAGE_ID = environ["ANNOTATION_DATA_ATTRIBUTES_PAGE_ID"]
11+
12+
configuration = Configuration()
13+
configuration.unstable_operations["get_page_annotations"] = True
14+
with ApiClient(configuration) as api_client:
15+
api_instance = AnnotationsApi(api_client)
16+
response = api_instance.get_page_annotations(
17+
page_id=ANNOTATION_DATA_ATTRIBUTES_PAGE_ID,
18+
start_time=1704067200000,
19+
end_time=1704153600000,
20+
)
21+
22+
print(response)

‎examples/v2/annotations/ListAnnotations.py‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
"""
2+
List annotations returns "OK" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.annotations_api import AnnotationsApi
8+
9+
# there is a valid "annotation" in the system
10+
ANNOTATION_DATA_ATTRIBUTES_PAGE_ID = environ["ANNOTATION_DATA_ATTRIBUTES_PAGE_ID"]
11+
12+
configuration = Configuration()
13+
configuration.unstable_operations["list_annotations"] = True
14+
with ApiClient(configuration) as api_client:
15+
api_instance = AnnotationsApi(api_client)
16+
response = api_instance.list_annotations(
17+
page_id=ANNOTATION_DATA_ATTRIBUTES_PAGE_ID,
18+
start_time=1704067200000,
19+
end_time=1704153600000,
20+
)
21+
22+
print(response)

‎examples/v2/annotations/UpdateAnnotation.py‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
"""
2+
Update an annotation returns "OK" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.annotations_api import AnnotationsApi
8+
from datadog_api_client.v2.model.annotation_color import AnnotationColor
9+
from datadog_api_client.v2.model.annotation_create_attributes import AnnotationCreateAttributes
10+
from datadog_api_client.v2.model.annotation_kind import AnnotationKind
11+
from datadog_api_client.v2.model.annotation_request_data import AnnotationRequestData
12+
from datadog_api_client.v2.model.annotation_type import AnnotationType
13+
from datadog_api_client.v2.model.annotation_update_request import AnnotationUpdateRequest
14+
15+
# there is a valid "annotation" in the system
16+
ANNOTATION_DATA_ID = environ["ANNOTATION_DATA_ID"]
17+
18+
body = AnnotationUpdateRequest(
19+
data=AnnotationRequestData(
20+
attributes=AnnotationCreateAttributes(
21+
color=AnnotationColor.GREEN,
22+
description="Updated annotation.",
23+
page_id="dashboard:abc-def-xyz",
24+
start_time=1704067200000,
25+
type=AnnotationKind.POINT_IN_TIME,
26+
),
27+
type=AnnotationType.ANNOTATION,
28+
),
29+
)
30+
31+
configuration = Configuration()
32+
configuration.unstable_operations["update_annotation"] = True
33+
with ApiClient(configuration) as api_client:
34+
api_instance = AnnotationsApi(api_client)
35+
response = api_instance.update_annotation(annotation_id=ANNOTATION_DATA_ID, body=body)
36+
37+
print(response)

‎src/datadog_api_client/configuration.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,11 @@ def __init__(
309309
"v2.update_llm_obs_dataset_records": False,
310310
"v2.update_llm_obs_experiment": False,
311311
"v2.update_llm_obs_project": False,
312+
"v2.create_annotation": False,
313+
"v2.delete_annotation": False,
314+
"v2.get_page_annotations": False,
315+
"v2.list_annotations": False,
316+
"v2.update_annotation": False,
312317
"v2.anonymize_users": False,
313318
"v2.validate": False,
314319
"v2.create_open_api": False,

0 commit comments

Comments
 (0)