Add missing incident attachments documentation (#3088)

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

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

.generator/schemas/v2/openapi.yaml

@@ -41880,6 +41880,83 @@ components:
       type: string
       x-enum-varnames:
       - PERMISSIONS
+    PostmortemAttachmentRequest:
+      properties:
+        data:
+          $ref: '#/components/schemas/PostmortemAttachmentRequestData'
+      required:
+      - data
+      type: object
+    PostmortemAttachmentRequestAttributes:
+      description: Postmortem attachment attributes
+      properties:
+        cells:
+          description: The cells of the postmortem
+          items:
+            $ref: '#/components/schemas/PostmortemCell'
+          type: array
+        content:
+          description: The content of the postmortem
+          example: '# Incident Report - IR-123
+
+            [...]'
+          type: string
+        postmortem_template_id:
+          description: The ID of the postmortem template
+          example: 93645509-874e-45c4-adfa-623bfeaead89-123
+          type: string
+        title:
+          description: The title of the postmortem
+          example: Postmortem-IR-123
+          type: string
+      type: object
+    PostmortemAttachmentRequestData:
+      description: Postmortem attachment data
+      properties:
+        attributes:
+          $ref: '#/components/schemas/PostmortemAttachmentRequestAttributes'
+        type:
+          $ref: '#/components/schemas/IncidentAttachmentType'
+      required:
+      - type
+      - attributes
+      type: object
+    PostmortemCell:
+      description: A cell in the postmortem
+      properties:
+        attributes:
+          $ref: '#/components/schemas/PostmortemCellAttributes'
+        id:
+          description: The unique identifier of the cell
+          example: cell-1
+          type: string
+        type:
+          $ref: '#/components/schemas/PostmortemCellType'
+      type: object
+    PostmortemCellAttributes:
+      description: Attributes of a postmortem cell
+      properties:
+        definition:
+          $ref: '#/components/schemas/PostmortemCellDefinition'
+      type: object
+    PostmortemCellDefinition:
+      description: Definition of a postmortem cell
+      properties:
+        content:
+          description: The content of the cell in markdown format
+          example: '## Incident Summary
+
+            This incident was caused by...'
+          type: string
+      type: object
+    PostmortemCellType:
+      description: The postmortem cell resource type.
+      enum:
+      - markdown
+      example: markdown
+      type: string
+      x-enum-varnames:
+      - MARKDOWN
     Powerpack:
       description: Powerpacks are templated groups of dashboard widgets you can save
         from an existing dashboard and turn into reusable packs in the widget tray.
@@ -71685,6 +71762,46 @@ paths:
         - incident_write
       x-unstable: '**Note**: This endpoint is in Preview.
 
+        If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+  /api/v2/incidents/{incident_id}/attachments/postmortems:
+    post:
+      description: Create a postmortem attachment for an incident.
+      operationId: CreateIncidentPostmortemAttachment
+      parameters:
+      - description: The ID of the incident
+        in: path
+        name: incident_id
+        required: true
+        schema:
+          example: 00000000-0000-0000-0000-000000000000
+          type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PostmortemAttachmentRequest'
+        required: true
+      responses:
+        '201':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Attachment'
+          description: Created
+        '400':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
+          description: Bad Request
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Create postmortem attachment
+      tags:
+      - Incidents
+      x-unstable: '**Note**: This endpoint is in public beta and it''s subject to
+        change.
+
         If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
   /api/v2/incidents/{incident_id}/attachments/{attachment_id}:
     delete:

docs/datadog_api_client.v2.model.rst

@@ -18183,6 +18183,55 @@ datadog\_api\_client.v2.model.permissions\_type module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.postmortem\_attachment\_request module
+--------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.postmortem_attachment_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.postmortem\_attachment\_request\_attributes module
+--------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.postmortem_attachment_request_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.postmortem\_attachment\_request\_data module
+--------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.postmortem_attachment_request_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.postmortem\_cell module
+-----------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.postmortem_cell
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.postmortem\_cell\_attributes module
+-----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.postmortem_cell_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.postmortem\_cell\_definition module
+-----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.postmortem_cell_definition
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.postmortem\_cell\_type module
+-----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.postmortem_cell_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.powerpack module
 ----------------------------------------------
 

examples/v2/incidents/CreateIncidentPostmortemAttachment.py

@@ -0,0 +1,46 @@
+"""
+Create postmortem 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.incident_attachment_type import IncidentAttachmentType
+from datadog_api_client.v2.model.postmortem_attachment_request import PostmortemAttachmentRequest
+from datadog_api_client.v2.model.postmortem_attachment_request_attributes import PostmortemAttachmentRequestAttributes
+from datadog_api_client.v2.model.postmortem_attachment_request_data import PostmortemAttachmentRequestData
+from datadog_api_client.v2.model.postmortem_cell import PostmortemCell
+from datadog_api_client.v2.model.postmortem_cell_attributes import PostmortemCellAttributes
+from datadog_api_client.v2.model.postmortem_cell_definition import PostmortemCellDefinition
+from datadog_api_client.v2.model.postmortem_cell_type import PostmortemCellType
+
+body = PostmortemAttachmentRequest(
+    data=PostmortemAttachmentRequestData(
+        attributes=PostmortemAttachmentRequestAttributes(
+            cells=[
+                PostmortemCell(
+                    attributes=PostmortemCellAttributes(
+                        definition=PostmortemCellDefinition(
+                            content="## Incident Summary\nThis incident was caused by...",
+                        ),
+                    ),
+                    id="cell-1",
+                    type=PostmortemCellType.MARKDOWN,
+                ),
+            ],
+            content="# Incident Report - IR-123\n[...]",
+            postmortem_template_id="93645509-874e-45c4-adfa-623bfeaead89-123",
+            title="Postmortem-IR-123",
+        ),
+        type=IncidentAttachmentType.INCIDENT_ATTACHMENTS,
+    ),
+)
+
+configuration = Configuration()
+configuration.unstable_operations["create_incident_postmortem_attachment"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = IncidentsApi(api_client)
+    response = api_instance.create_incident_postmortem_attachment(
+        incident_id="00000000-0000-0000-0000-000000000000", body=body
+    )
+
+    print(response)

src/datadog_api_client/configuration.py

@@ -311,6 +311,7 @@ def __init__(
                 "v2.create_incident_integration": False,
                 "v2.create_incident_notification_rule": False,
                 "v2.create_incident_notification_template": False,
+                "v2.create_incident_postmortem_attachment": False,
                 "v2.create_incident_todo": False,
                 "v2.create_incident_type": False,
                 "v2.delete_incident": False,

src/datadog_api_client/v2/api/incidents_api.py

@@ -46,6 +46,7 @@
 from datadog_api_client.v2.model.attachment_array import AttachmentArray
 from datadog_api_client.v2.model.attachment import Attachment
 from datadog_api_client.v2.model.create_attachment_request import CreateAttachmentRequest
+from datadog_api_client.v2.model.postmortem_attachment_request import PostmortemAttachmentRequest
 from datadog_api_client.v2.model.patch_attachment_request import PatchAttachmentRequest
 from datadog_api_client.v2.model.incident_impacts_response import IncidentImpactsResponse
 from datadog_api_client.v2.model.incident_impact_related_object import IncidentImpactRelatedObject
@@ -226,6 +227,32 @@ def __init__(self, api_client=None):
             api_client=api_client,
         )
 
+        self._create_incident_postmortem_attachment_endpoint = _Endpoint(
+            settings={
+                "response_type": (Attachment,),
+                "auth": ["apiKeyAuth", "appKeyAuth"],
+                "endpoint_path": "/api/v2/incidents/{incident_id}/attachments/postmortems",
+                "operation_id": "create_incident_postmortem_attachment",
+                "http_method": "POST",
+                "version": "v2",
+            },
+            params_map={
+                "incident_id": {
+                    "required": True,
+                    "openapi_types": (str,),
+                    "attribute": "incident_id",
+                    "location": "path",
+                },
+                "body": {
+                    "required": True,
+                    "openapi_types": (PostmortemAttachmentRequest,),
+                    "location": "body",
+                },
+            },
+            headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
+            api_client=api_client,
+        )
+
         self._create_incident_todo_endpoint = _Endpoint(
             settings={
                 "response_type": (IncidentTodoResponse,),
@@ -1282,6 +1309,27 @@ def create_incident_notification_template(
 
         return self._create_incident_notification_template_endpoint.call_with_http_info(**kwargs)
 
+    def create_incident_postmortem_attachment(
+        self,
+        incident_id: str,
+        body: PostmortemAttachmentRequest,
+    ) -> Attachment:
+        """Create postmortem attachment.
+
+        Create a postmortem attachment for an incident.
+
+        :param incident_id: The ID of the incident
+        :type incident_id: str
+        :type body: PostmortemAttachmentRequest
+        :rtype: Attachment
+        """
+        kwargs: Dict[str, Any] = {}
+        kwargs["incident_id"] = incident_id
+
+        kwargs["body"] = body
+
+        return self._create_incident_postmortem_attachment_endpoint.call_with_http_info(**kwargs)
+
     def create_incident_todo(
         self,
         incident_id: str,

src/datadog_api_client/v2/model/postmortem_attachment_request.py

@@ -0,0 +1,40 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v2.model.postmortem_attachment_request_data import PostmortemAttachmentRequestData
+
+
+class PostmortemAttachmentRequest(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v2.model.postmortem_attachment_request_data import PostmortemAttachmentRequestData
+
+        return {
+            "data": (PostmortemAttachmentRequestData,),
+        }
+
+    attribute_map = {
+        "data": "data",
+    }
+
+    def __init__(self_, data: PostmortemAttachmentRequestData, **kwargs):
+        """
+
+
+        :param data: Postmortem attachment data
+        :type data: PostmortemAttachmentRequestData
+        """
+        super().__init__(kwargs)
+
+        self_.data = data