Add documentation for GET, POST, PATCH, and DELETE api/v2/incidents/incident_id/attachments endpoints (#2995)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -1271,6 +1271,76 @@ datadog\_api\_client.v2.model.attach\_jira\_issue\_request\_data\_relationships
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.attachment module
+-----------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.attachment
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.attachment\_array module
+------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.attachment_array
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.attachment\_data module
+-----------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.attachment_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.attachment\_data\_attributes module
+-----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.attachment_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.attachment\_data\_attributes\_attachment module
+-----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.attachment_data_attributes_attachment
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.attachment\_data\_attributes\_attachment\_type module
+-----------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.attachment_data_attributes_attachment_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.attachment\_data\_relationships module
+--------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.attachment_data_relationships
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.attachment\_data\_relationships\_last\_modified\_by\_user module
+----------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.attachment_data_relationships_last_modified_by_user
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.attachment\_data\_relationships\_last\_modified\_by\_user\_data module
+----------------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.attachment_data_relationships_last_modified_by_user_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.attachment\_included module
+---------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.attachment_included
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.audit\_logs\_event module
 -------------------------------------------------------
 
@@ -5128,6 +5198,34 @@ datadog\_api\_client.v2.model.create\_apps\_datastore\_response\_data module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.create\_attachment\_request module
+----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.create_attachment_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.create\_attachment\_request\_data module
+----------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.create_attachment_request_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.create\_attachment\_request\_data\_attributes module
+----------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.create_attachment_request_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.create\_attachment\_request\_data\_attributes\_attachment module
+----------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.create_attachment_request_data_attributes_attachment
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.create\_case\_request\_array module
 -----------------------------------------------------------------
 
@@ -10847,132 +10945,13 @@ datadog\_api\_client.v2.model.idp\_metadata\_form\_data module
    :members:
    :show-inheritance:
 
-datadog\_api\_client.v2.model.incident\_attachment\_attachment\_type module
----------------------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.model.incident_attachment_attachment_type
-   :members:
-   :show-inheritance:
-
-datadog\_api\_client.v2.model.incident\_attachment\_attributes module
----------------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.model.incident_attachment_attributes
-   :members:
-   :show-inheritance:
-
-datadog\_api\_client.v2.model.incident\_attachment\_data module
----------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.model.incident_attachment_data
-   :members:
-   :show-inheritance:
-
-datadog\_api\_client.v2.model.incident\_attachment\_link\_attachment\_type module
----------------------------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.model.incident_attachment_link_attachment_type
-   :members:
-   :show-inheritance:
-
-datadog\_api\_client.v2.model.incident\_attachment\_link\_attributes module
----------------------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.model.incident_attachment_link_attributes
-   :members:
-   :show-inheritance:
-
-datadog\_api\_client.v2.model.incident\_attachment\_link\_attributes\_attachment\_object module
------------------------------------------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.model.incident_attachment_link_attributes_attachment_object
-   :members:
-   :show-inheritance:
-
-datadog\_api\_client.v2.model.incident\_attachment\_postmortem\_attachment\_type module
----------------------------------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.model.incident_attachment_postmortem_attachment_type
-   :members:
-   :show-inheritance:
-
-datadog\_api\_client.v2.model.incident\_attachment\_postmortem\_attributes module
----------------------------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.model.incident_attachment_postmortem_attributes
-   :members:
-   :show-inheritance:
-
-datadog\_api\_client.v2.model.incident\_attachment\_related\_object module
---------------------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.model.incident_attachment_related_object
-   :members:
-   :show-inheritance:
-
-datadog\_api\_client.v2.model.incident\_attachment\_relationships module
-------------------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.model.incident_attachment_relationships
-   :members:
-   :show-inheritance:
-
 datadog\_api\_client.v2.model.incident\_attachment\_type module
 ---------------------------------------------------------------
 
 .. automodule:: datadog_api_client.v2.model.incident_attachment_type
    :members:
    :show-inheritance:
 
-datadog\_api\_client.v2.model.incident\_attachment\_update\_attributes module
------------------------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.model.incident_attachment_update_attributes
-   :members:
-   :show-inheritance:
-
-datadog\_api\_client.v2.model.incident\_attachment\_update\_data module
------------------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.model.incident_attachment_update_data
-   :members:
-   :show-inheritance:
-
-datadog\_api\_client.v2.model.incident\_attachment\_update\_request module
---------------------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.model.incident_attachment_update_request
-   :members:
-   :show-inheritance:
-
-datadog\_api\_client.v2.model.incident\_attachment\_update\_response module
----------------------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.model.incident_attachment_update_response
-   :members:
-   :show-inheritance:
-
-datadog\_api\_client.v2.model.incident\_attachments\_postmortem\_attributes\_attachment\_object module
-------------------------------------------------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.model.incident_attachments_postmortem_attributes_attachment_object
-   :members:
-   :show-inheritance:
-
-datadog\_api\_client.v2.model.incident\_attachments\_response module
---------------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.model.incident_attachments_response
-   :members:
-   :show-inheritance:
-
-datadog\_api\_client.v2.model.incident\_attachments\_response\_included\_item module
-------------------------------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.model.incident_attachments_response_included_item
-   :members:
-   :show-inheritance:
-
 datadog\_api\_client.v2.model.incident\_create\_attributes module
 -----------------------------------------------------------------
 
@@ -17714,6 +17693,34 @@ datadog\_api\_client.v2.model.partial\_application\_key\_response module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.patch\_attachment\_request module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.patch_attachment_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.patch\_attachment\_request\_data module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.patch_attachment_request_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.patch\_attachment\_request\_data\_attributes module
+---------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.patch_attachment_request_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.patch\_attachment\_request\_data\_attributes\_attachment module
+---------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.patch_attachment_request_data_attributes_attachment
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.patch\_incident\_notification\_template\_request module
 -------------------------------------------------------------------------------------
 
@@ -25358,6 +25365,13 @@ datadog\_api\_client.v2.model.user module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.user140420082644000 module
+--------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.user140420082644000
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.user\_attributes module
 -----------------------------------------------------
 
@@ -25624,6 +25638,13 @@ datadog\_api\_client.v2.model.user\_teams\_response module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.user\_type module
+-----------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.user_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.user\_update\_attributes module
 -------------------------------------------------------------
 

docs/datadog_api_client.v2.model.rst

@@ -0,0 +1,38 @@
+"""
+Create incident attachment 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.attachment_data_attributes_attachment_type import (
+    AttachmentDataAttributesAttachmentType,
+)
+from datadog_api_client.v2.model.create_attachment_request import CreateAttachmentRequest
+from datadog_api_client.v2.model.create_attachment_request_data import CreateAttachmentRequestData
+from datadog_api_client.v2.model.create_attachment_request_data_attributes import CreateAttachmentRequestDataAttributes
+from datadog_api_client.v2.model.create_attachment_request_data_attributes_attachment import (
+    CreateAttachmentRequestDataAttributesAttachment,
+)
+from datadog_api_client.v2.model.incident_attachment_type import IncidentAttachmentType
+
+body = CreateAttachmentRequest(
+    data=CreateAttachmentRequestData(
+        attributes=CreateAttachmentRequestDataAttributes(
+            attachment=CreateAttachmentRequestDataAttributesAttachment(
+                document_url="https://app.datadoghq.com/notebook/123/Postmortem-IR-123",
+                title="Postmortem-IR-123",
+            ),
+            attachment_type=AttachmentDataAttributesAttachmentType.POSTMORTEM,
+        ),
+        id="00000000-0000-0000-0000-000000000000",
+        type=IncidentAttachmentType.INCIDENT_ATTACHMENTS,
+    ),
+)
+
+configuration = Configuration()
+configuration.unstable_operations["create_incident_attachment"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = IncidentsApi(api_client)
+    response = api_instance.create_incident_attachment(incident_id="incident_id", body=body)
+
+    print(response)

examples/v2/incidents/CreateIncidentAttachment.py

@@ -0,0 +1,15 @@
+"""
+Delete incident attachment 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_attachment"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = IncidentsApi(api_client)
+    api_instance.delete_incident_attachment(
+        incident_id="incident_id",
+        attachment_id="00000000-0000-0000-0000-000000000002",
+    )

examples/v2/incidents/DeleteIncidentAttachment.py

@@ -1,5 +1,5 @@
 """
-Get a list of attachments returns "OK" response
+List incident attachments returns "OK" response
 """
 
 from datadog_api_client import ApiClient, Configuration