Add Annotations API v2 spec

docs/datadog_api_client.v2.api.rst

@@ -25,6 +25,13 @@ datadog\_api\_client.v2.api.agentless\_scanning\_api module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.api.annotations\_api module
+---------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.api.annotations_api
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.api.api\_management\_api module
 -------------------------------------------------------
 
@@ -473,6 +480,13 @@ datadog\_api\_client.v2.api.network\_device\_monitoring\_api module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.api.o\_auth2\_client\_public\_api module
+----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.api.o_auth2_client_public_api
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.api.observability\_pipelines\_api module
 ----------------------------------------------------------------
 

docs/datadog_api_client.v2.model.rst

@@ -767,6 +767,41 @@ datadog\_api\_client.v2.model.annotation module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.annotation\_attributes module
+-----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.annotation_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.annotation\_color module
+------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.annotation_color
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.annotation\_create\_attributes module
+-------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.annotation_create_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.annotation\_create\_request module
+----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.annotation_create_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.annotation\_data module
+-----------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.annotation_data
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.annotation\_display module
 --------------------------------------------------------
 
@@ -781,13 +816,69 @@ datadog\_api\_client.v2.model.annotation\_display\_bounds module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.annotation\_in\_page module
+---------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.annotation_in_page
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.annotation\_kind module
+-----------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.annotation_kind
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.annotation\_markdown\_text\_annotation module
 ---------------------------------------------------------------------------
 
 .. automodule:: datadog_api_client.v2.model.annotation_markdown_text_annotation
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.annotation\_request\_data module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.annotation_request_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.annotation\_response module
+---------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.annotation_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.annotation\_type module
+-----------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.annotation_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.annotation\_update\_request module
+----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.annotation_update_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.annotations\_in\_page\_map module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.annotations_in_page_map
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.annotations\_response module
+----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.annotations_response
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.anonymize\_user\_error module
 -----------------------------------------------------------
 
@@ -23447,6 +23538,83 @@ datadog\_api\_client.v2.model.nullable\_user\_relationship\_data module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.o\_auth\_client\_registration\_error module
+-------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.o_auth_client_registration_error
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.o\_auth\_client\_registration\_grant\_type module
+-------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.o_auth_client_registration_grant_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.o\_auth\_client\_registration\_request module
+---------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.o_auth_client_registration_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.o\_auth\_client\_registration\_response module
+----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.o_auth_client_registration_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.o\_auth\_client\_registration\_response\_type module
+----------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.o_auth_client_registration_response_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.o\_auth\_oidc\_scope module
+---------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.o_auth_oidc_scope
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.o\_auth\_scopes\_restriction module
+-----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.o_auth_scopes_restriction
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.o\_auth\_scopes\_restriction\_response module
+---------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.o_auth_scopes_restriction_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.o\_auth\_scopes\_restriction\_response\_attributes module
+---------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.o_auth_scopes_restriction_response_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.o\_auth\_scopes\_restriction\_response\_data module
+---------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.o_auth_scopes_restriction_response_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.o\_auth\_scopes\_restriction\_type module
+-----------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.o_auth_scopes_restriction_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.observability\_pipeline module
 ------------------------------------------------------------
 
@@ -26996,6 +27164,34 @@ datadog\_api\_client.v2.model.overwrite\_allocations\_request module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.page\_annotations\_attributes module
+------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.page_annotations_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.page\_annotations\_data module
+------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.page_annotations_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.page\_annotations\_response module
+----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.page_annotations_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.page\_annotations\_type module
+------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.page_annotations_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.page\_urgency module
 --------------------------------------------------
 
@@ -40261,6 +40457,34 @@ datadog\_api\_client.v2.model.upsert\_cloud\_inventory\_sync\_config\_request\_d
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.upsert\_o\_auth\_scopes\_restriction\_data module
+-------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.upsert_o_auth_scopes_restriction_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.upsert\_o\_auth\_scopes\_restriction\_data\_attributes module
+-------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.upsert_o_auth_scopes_restriction_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.upsert\_o\_auth\_scopes\_restriction\_request module
+----------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.upsert_o_auth_scopes_restriction_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.upsert\_o\_auth\_scopes\_restriction\_type module
+-------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.upsert_o_auth_scopes_restriction_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.urgency module
 --------------------------------------------
 
@@ -41150,6 +41374,13 @@ datadog\_api\_client.v2.model.weekday module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.widget\_annotations\_map module
+-------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.widget_annotations_map
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.widget\_attributes module
 -------------------------------------------------------
 

examples/v2/annotations/CreateAnnotation.py

@@ -0,0 +1,36 @@
+"""
+Create an annotation returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.annotations_api import AnnotationsApi
+from datadog_api_client.v2.model.annotation_color import AnnotationColor
+from datadog_api_client.v2.model.annotation_create_attributes import AnnotationCreateAttributes
+from datadog_api_client.v2.model.annotation_create_request import AnnotationCreateRequest
+from datadog_api_client.v2.model.annotation_kind import AnnotationKind
+from datadog_api_client.v2.model.annotation_request_data import AnnotationRequestData
+from datadog_api_client.v2.model.annotation_type import AnnotationType
+
+body = AnnotationCreateRequest(
+    data=AnnotationRequestData(
+        attributes=AnnotationCreateAttributes(
+            color=AnnotationColor.BLUE,
+            description="Deployed v2.3.1 to production.",
+            page_id="dashboard:abc-def-xyz",
+            start_time=1704067200000,
+            type=AnnotationKind.POINT_IN_TIME,
+            widget_ids=[
+                "1234567890",
+            ],
+        ),
+        type=AnnotationType.ANNOTATION,
+    ),
+)
+
+configuration = Configuration()
+configuration.unstable_operations["create_annotation"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = AnnotationsApi(api_client)
+    response = api_instance.create_annotation(body=body)
+
+    print(response)

examples/v2/annotations/DeleteAnnotation.py

@@ -0,0 +1,18 @@
+"""
+Delete an annotation returns "No Content" response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.annotations_api import AnnotationsApi
+
+# there is a valid "annotation" in the system
+ANNOTATION_DATA_ID = environ["ANNOTATION_DATA_ID"]
+
+configuration = Configuration()
+configuration.unstable_operations["delete_annotation"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = AnnotationsApi(api_client)
+    api_instance.delete_annotation(
+        annotation_id=ANNOTATION_DATA_ID,
+    )

examples/v2/annotations/GetPageAnnotations.py

@@ -0,0 +1,22 @@
+"""
+Get annotations for a page returns "OK" response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.annotations_api import AnnotationsApi
+
+# there is a valid "annotation" in the system
+ANNOTATION_DATA_ATTRIBUTES_PAGE_ID = environ["ANNOTATION_DATA_ATTRIBUTES_PAGE_ID"]
+
+configuration = Configuration()
+configuration.unstable_operations["get_page_annotations"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = AnnotationsApi(api_client)
+    response = api_instance.get_page_annotations(
+        page_id=ANNOTATION_DATA_ATTRIBUTES_PAGE_ID,
+        start_time=1704067200000,
+        end_time=1704153600000,
+    )
+
+    print(response)