Skip to content

[CASEM] Document comment and custom attributes endpoints #2636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: v2
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .generated-info
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"spec_repo_commit": "d02c8a3",
"generated": "2025-08-08 12:07:03.564"
"spec_repo_commit": "5d6481a",
"generated": "2025-08-12 11:13:03.789"
}
176 changes: 176 additions & 0 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7280,6 +7280,35 @@ components:
type:
$ref: '#/components/schemas/CaseType'
type: object
CaseComment:
description: Case comment
properties:
attributes:
$ref: '#/components/schemas/CaseCommentAttributes'
type:
$ref: '#/components/schemas/CaseResourceType'
required:
- attributes
- type
type: object
CaseCommentAttributes:
description: Case comment attributes
properties:
comment:
description: The `CaseCommentAttributes` `message`.
example: This is my comment !
type: string
required:
- comment
type: object
CaseCommentRequest:
description: Case comment request
properties:
data:
$ref: '#/components/schemas/CaseComment'
required:
- data
type: object
CaseCreate:
description: Case creation data
properties:
Expand Down Expand Up @@ -42538,6 +42567,120 @@ components:
- time_zone
- restrictions
type: object
TimelineCell:
description: timeline cell
properties:
author:
$ref: '#/components/schemas/TimelineCellAuthor'
cell_content:
$ref: '#/components/schemas/TimelineCellContent'
created_at:
description: Timestamp of when the cell was created
format: date-time
readOnly: true
type: string
deleted_at:
description: Timestamp of when the cell was deleted
format: date-time
readOnly: true
type: string
modified_at:
description: Timestamp of when the cell was last modified
format: date-time
readOnly: true
type: string
type:
$ref: '#/components/schemas/TimelineCellType'
type: object
TimelineCellAuthor:
description: author of the timeline cell
oneOf:
- $ref: '#/components/schemas/TimelineCellAuthorUser'
TimelineCellAuthorUser:
description: timeline cell user author
properties:
content:
$ref: '#/components/schemas/TimelineCellAuthorUserContent'
type:
$ref: '#/components/schemas/TimelineCellAuthorUserType'
type: object
TimelineCellAuthorUserContent:
description: user author content.
properties:
email:
description: user email
type: string
handle:
description: user handle
type: string
id:
description: user UUID
type: string
name:
description: user name
type: string
type: object
TimelineCellAuthorUserType:
description: user author type.
enum:
- USER
example: USER
type: string
x-enum-varnames:
- USER
TimelineCellContent:
description: timeline cell content
oneOf:
- $ref: '#/components/schemas/TimelineCellContentComment'
TimelineCellContentComment:
description: comment content
properties:
message:
description: comment message
type: string
type: object
TimelineCellResource:
description: Timeline cell JSON:API resource
properties:
attributes:
$ref: '#/components/schemas/TimelineCell'
id:
description: Timeline cell's identifier
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
type: string
type:
$ref: '#/components/schemas/TimelineCellResourceType'
required:
- id
- type
- attributes
type: object
TimelineCellResourceType:
default: timeline_cell
description: Timeline cell JSON:API resource type
enum:
- timeline_cell
example: timeline_cell
type: string
x-enum-varnames:
- TIMELINE_CELL
TimelineCellType:
description: Timeline cell content type
enum:
- COMMENT
example: COMMENT
type: string
x-enum-varnames:
- COMMENT
TimelineResponse:
description: Timeline response
properties:
data:
description: The `TimelineResponse` `data`.
items:
$ref: '#/components/schemas/TimelineCellResource'
type: array
type: object
TimeseriesFormulaQueryRequest:
description: A request wrapper around a single timeseries query to be executed.
properties:
Expand Down Expand Up @@ -47570,6 +47713,39 @@ paths:
summary: Update case attributes
tags:
- Case Management
/api/v2/cases/{case_id}/comment:
post:
description: Comment case
operationId: CommentCase
parameters:
- $ref: '#/components/parameters/CaseIDPathParameter'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CaseCommentRequest'
description: Case comment payload
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TimelineResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Comment case
tags:
- Case Management
/api/v2/cases/{case_id}/priority:
post:
description: Update case priority
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
"2025-07-21T13:52:40.919Z"
"2025-08-12T11:05:35.408Z"
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@
"url": "https://api.datadoghq.com/api/v2/cases"
},
"response": {
"bodySize": 838,
"bodySize": 839,
"content": {
"mimeType": "application/vnd.api+json",
"size": 838,
"text": "{\"data\":{\"id\":\"6706fe66-cabd-4b22-b4c5-dd478bba421a\",\"type\":\"case\",\"attributes\":{\"attributes\":{},\"comment_count\":0,\"created_at\":\"2025-07-21T13:52:41.25066Z\",\"creation_source\":\"MANUAL\",\"custom_attributes\":{},\"description\":\"\",\"insights\":[],\"internal_id\":\"6706fe66-cabd-4b22-b4c5-dd478bba421a\",\"key\":\"DDFC-72317\",\"merge_status\":\"NOT_MERGED\",\"priority\":\"P4\",\"public_id\":\"72377\",\"status\":\"OPEN\",\"title\":\"My new case\",\"type\":\"STANDARD\",\"type_id\":\"00000000-0000-0000-0000-000000000001\"},\"relationships\":{\"created_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"project\":{\"data\":{\"id\":\"d4bbe1af-f36e-42f1-87c1-493ca35c320e\",\"type\":\"project\"}}}},\"included\":[{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\",\"attributes\":{\"active\":true,\"email\":\"[email protected]\",\"handle\":\"[email protected]\",\"name\":\"frog\"}}]}"
"size": 839,
"text": "{\"data\":{\"id\":\"77547410-8537-458a-9384-dcfe251d7c7e\",\"type\":\"case\",\"attributes\":{\"attributes\":{},\"comment_count\":0,\"created_at\":\"2025-08-12T11:05:35.824748Z\",\"creation_source\":\"MANUAL\",\"custom_attributes\":{},\"description\":\"\",\"insights\":[],\"internal_id\":\"77547410-8537-458a-9384-dcfe251d7c7e\",\"key\":\"DDFC-75922\",\"merge_status\":\"NOT_MERGED\",\"priority\":\"P4\",\"public_id\":\"75982\",\"status\":\"OPEN\",\"title\":\"My new case\",\"type\":\"STANDARD\",\"type_id\":\"00000000-0000-0000-0000-000000000001\"},\"relationships\":{\"created_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"project\":{\"data\":{\"id\":\"d4bbe1af-f36e-42f1-87c1-493ca35c320e\",\"type\":\"project\"}}}},\"included\":[{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\",\"attributes\":{\"active\":true,\"email\":\"[email protected]\",\"handle\":\"[email protected]\",\"name\":\"frog\"}}]}"
},
"cookies": [],
"headers": [
Expand All @@ -57,11 +57,11 @@
"status": 201,
"statusText": "Created"
},
"startedDateTime": "2025-07-21T13:52:40.926Z",
"time": 397
"startedDateTime": "2025-08-12T11:05:35.415Z",
"time": 439
},
{
"_id": "75643134d0d3233903bf06a1fd35338d",
"_id": "f878fd82be15daac32ba7b7e485a4330",
"_order": 0,
"cache": {},
"request": {
Expand All @@ -88,7 +88,7 @@
"text": "{\"data\":{\"type\":\"project\"}}"
},
"queryString": [],
"url": "https://api.datadoghq.com/api/v2/cases/6706fe66-cabd-4b22-b4c5-dd478bba421a/archive"
"url": "https://api.datadoghq.com/api/v2/cases/77547410-8537-458a-9384-dcfe251d7c7e/archive"
},
"response": {
"bodySize": 108,
Expand All @@ -110,8 +110,8 @@
"status": 400,
"statusText": "Bad Request"
},
"startedDateTime": "2025-07-21T13:52:41.332Z",
"time": 372
"startedDateTime": "2025-08-12T11:05:35.864Z",
"time": 384
}
],
"pages": [],
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
"2025-07-21T13:52:41.730Z"
"2025-08-12T11:05:36.261Z"
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@
"status": 404,
"statusText": "Not Found"
},
"startedDateTime": "2025-07-21T13:52:41.735Z",
"time": 392
"startedDateTime": "2025-08-12T11:05:36.264Z",
"time": 397
}
],
"pages": [],
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
"2025-07-21T13:52:42.155Z"
"2025-08-12T11:05:36.670Z"
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@
"url": "https://api.datadoghq.com/api/v2/cases"
},
"response": {
"bodySize": 838,
"bodySize": 839,
"content": {
"mimeType": "application/vnd.api+json",
"size": 838,
"text": "{\"data\":{\"id\":\"b074b409-24f8-42ae-b545-b1486429630d\",\"type\":\"case\",\"attributes\":{\"attributes\":{},\"comment_count\":0,\"created_at\":\"2025-07-21T13:52:42.51392Z\",\"creation_source\":\"MANUAL\",\"custom_attributes\":{},\"description\":\"\",\"insights\":[],\"internal_id\":\"b074b409-24f8-42ae-b545-b1486429630d\",\"key\":\"DDFC-72318\",\"merge_status\":\"NOT_MERGED\",\"priority\":\"P4\",\"public_id\":\"72378\",\"status\":\"OPEN\",\"title\":\"My new case\",\"type\":\"STANDARD\",\"type_id\":\"00000000-0000-0000-0000-000000000001\"},\"relationships\":{\"created_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"project\":{\"data\":{\"id\":\"d4bbe1af-f36e-42f1-87c1-493ca35c320e\",\"type\":\"project\"}}}},\"included\":[{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\",\"attributes\":{\"active\":true,\"email\":\"[email protected]\",\"handle\":\"[email protected]\",\"name\":\"frog\"}}]}"
"size": 839,
"text": "{\"data\":{\"id\":\"dc347aa5-0e19-44fe-9ba3-0114728a47a1\",\"type\":\"case\",\"attributes\":{\"attributes\":{},\"comment_count\":0,\"created_at\":\"2025-08-12T11:05:37.067799Z\",\"creation_source\":\"MANUAL\",\"custom_attributes\":{},\"description\":\"\",\"insights\":[],\"internal_id\":\"dc347aa5-0e19-44fe-9ba3-0114728a47a1\",\"key\":\"DDFC-75923\",\"merge_status\":\"NOT_MERGED\",\"priority\":\"P4\",\"public_id\":\"75983\",\"status\":\"OPEN\",\"title\":\"My new case\",\"type\":\"STANDARD\",\"type_id\":\"00000000-0000-0000-0000-000000000001\"},\"relationships\":{\"created_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"project\":{\"data\":{\"id\":\"d4bbe1af-f36e-42f1-87c1-493ca35c320e\",\"type\":\"project\"}}}},\"included\":[{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\",\"attributes\":{\"active\":true,\"email\":\"[email protected]\",\"handle\":\"[email protected]\",\"name\":\"frog\"}}]}"
},
"cookies": [],
"headers": [
Expand All @@ -57,11 +57,11 @@
"status": 201,
"statusText": "Created"
},
"startedDateTime": "2025-07-21T13:52:42.177Z",
"time": 412
"startedDateTime": "2025-08-12T11:05:36.673Z",
"time": 400
},
{
"_id": "f102e9889a3b0592a1d5f6e9c4d2deb8",
"_id": "3dc20d754a42cb5524f5a085f9c59be2",
"_order": 0,
"cache": {},
"request": {
Expand All @@ -88,14 +88,14 @@
"text": "{\"data\":{\"type\":\"case\"}}"
},
"queryString": [],
"url": "https://api.datadoghq.com/api/v2/cases/b074b409-24f8-42ae-b545-b1486429630d/archive"
"url": "https://api.datadoghq.com/api/v2/cases/dc347aa5-0e19-44fe-9ba3-0114728a47a1/archive"
},
"response": {
"bodySize": 1012,
"bodySize": 1013,
"content": {
"mimeType": "application/vnd.api+json",
"size": 1012,
"text": "{\"data\":{\"id\":\"b074b409-24f8-42ae-b545-b1486429630d\",\"type\":\"case\",\"attributes\":{\"archived_at\":\"2025-07-21T13:52:42.933945716Z\",\"attributes\":{},\"comment_count\":0,\"created_at\":\"2025-07-21T13:52:42.51392Z\",\"creation_source\":\"MANUAL\",\"custom_attributes\":{},\"description\":\"\",\"insights\":[],\"internal_id\":\"b074b409-24f8-42ae-b545-b1486429630d\",\"key\":\"DDFC-72318\",\"merge_status\":\"NOT_MERGED\",\"modified_at\":\"2025-07-21T13:52:42.933946Z\",\"priority\":\"P4\",\"public_id\":\"72378\",\"status\":\"OPEN\",\"title\":\"My new case\",\"type\":\"STANDARD\",\"type_id\":\"00000000-0000-0000-0000-000000000001\"},\"relationships\":{\"created_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"modified_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"project\":{\"data\":{\"id\":\"d4bbe1af-f36e-42f1-87c1-493ca35c320e\",\"type\":\"project\"}}}},\"included\":[{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\",\"attributes\":{\"active\":true,\"email\":\"[email protected]\",\"handle\":\"[email protected]\",\"name\":\"frog\"}}]}"
"size": 1013,
"text": "{\"data\":{\"id\":\"dc347aa5-0e19-44fe-9ba3-0114728a47a1\",\"type\":\"case\",\"attributes\":{\"archived_at\":\"2025-08-12T11:05:37.477128247Z\",\"attributes\":{},\"comment_count\":0,\"created_at\":\"2025-08-12T11:05:37.067799Z\",\"creation_source\":\"MANUAL\",\"custom_attributes\":{},\"description\":\"\",\"insights\":[],\"internal_id\":\"dc347aa5-0e19-44fe-9ba3-0114728a47a1\",\"key\":\"DDFC-75923\",\"merge_status\":\"NOT_MERGED\",\"modified_at\":\"2025-08-12T11:05:37.477128Z\",\"priority\":\"P4\",\"public_id\":\"75983\",\"status\":\"OPEN\",\"title\":\"My new case\",\"type\":\"STANDARD\",\"type_id\":\"00000000-0000-0000-0000-000000000001\"},\"relationships\":{\"created_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"modified_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"project\":{\"data\":{\"id\":\"d4bbe1af-f36e-42f1-87c1-493ca35c320e\",\"type\":\"project\"}}}},\"included\":[{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\",\"attributes\":{\"active\":true,\"email\":\"[email protected]\",\"handle\":\"[email protected]\",\"name\":\"frog\"}}]}"
},
"cookies": [],
"headers": [
Expand All @@ -110,8 +110,8 @@
"status": 200,
"statusText": "OK"
},
"startedDateTime": "2025-07-21T13:52:42.597Z",
"time": 412
"startedDateTime": "2025-08-12T11:05:37.081Z",
"time": 407
}
],
"pages": [],
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
"2025-07-21T13:52:43.015Z"
"2025-08-12T11:05:37.497Z"
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
"content": {
"mimeType": "application/vnd.api+json",
"size": 839,
"text": "{\"data\":{\"id\":\"510b0121-1477-43c0-8986-78f011016d48\",\"type\":\"case\",\"attributes\":{\"attributes\":{},\"comment_count\":0,\"created_at\":\"2025-07-21T13:52:43.335245Z\",\"creation_source\":\"MANUAL\",\"custom_attributes\":{},\"description\":\"\",\"insights\":[],\"internal_id\":\"510b0121-1477-43c0-8986-78f011016d48\",\"key\":\"DDFC-72319\",\"merge_status\":\"NOT_MERGED\",\"priority\":\"P4\",\"public_id\":\"72379\",\"status\":\"OPEN\",\"title\":\"My new case\",\"type\":\"STANDARD\",\"type_id\":\"00000000-0000-0000-0000-000000000001\"},\"relationships\":{\"created_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"project\":{\"data\":{\"id\":\"d4bbe1af-f36e-42f1-87c1-493ca35c320e\",\"type\":\"project\"}}}},\"included\":[{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\",\"attributes\":{\"active\":true,\"email\":\"[email protected]\",\"handle\":\"[email protected]\",\"name\":\"frog\"}}]}"
"text": "{\"data\":{\"id\":\"86b3e00d-7c2d-4683-8007-6514c321628a\",\"type\":\"case\",\"attributes\":{\"attributes\":{},\"comment_count\":0,\"created_at\":\"2025-08-12T11:05:37.877307Z\",\"creation_source\":\"MANUAL\",\"custom_attributes\":{},\"description\":\"\",\"insights\":[],\"internal_id\":\"86b3e00d-7c2d-4683-8007-6514c321628a\",\"key\":\"DDFC-75924\",\"merge_status\":\"NOT_MERGED\",\"priority\":\"P4\",\"public_id\":\"75984\",\"status\":\"OPEN\",\"title\":\"My new case\",\"type\":\"STANDARD\",\"type_id\":\"00000000-0000-0000-0000-000000000001\"},\"relationships\":{\"created_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"project\":{\"data\":{\"id\":\"d4bbe1af-f36e-42f1-87c1-493ca35c320e\",\"type\":\"project\"}}}},\"included\":[{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\",\"attributes\":{\"active\":true,\"email\":\"[email protected]\",\"handle\":\"[email protected]\",\"name\":\"frog\"}}]}"
},
"cookies": [],
"headers": [
Expand All @@ -57,11 +57,11 @@
"status": 201,
"statusText": "Created"
},
"startedDateTime": "2025-07-21T13:52:43.017Z",
"time": 384
"startedDateTime": "2025-08-12T11:05:37.499Z",
"time": 385
},
{
"_id": "389b3a16ce3121bf75a0da30a1d8d867",
"_id": "924a1ee4b0a69de2492dde4ef2150af6",
"_order": 0,
"cache": {},
"request": {
Expand All @@ -88,7 +88,7 @@
"text": "{\"data\":{\"attributes\":{\"assignee_id\":\"invalid-uuid\"},\"type\":\"case\"}}"
},
"queryString": [],
"url": "https://api.datadoghq.com/api/v2/cases/510b0121-1477-43c0-8986-78f011016d48/assign"
"url": "https://api.datadoghq.com/api/v2/cases/86b3e00d-7c2d-4683-8007-6514c321628a/assign"
},
"response": {
"bodySize": 51,
Expand All @@ -110,8 +110,8 @@
"status": 400,
"statusText": "Bad Request"
},
"startedDateTime": "2025-07-21T13:52:43.407Z",
"time": 399
"startedDateTime": "2025-08-12T11:05:37.889Z",
"time": 376
}
],
"pages": [],
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
"2025-07-21T13:52:43.820Z"
"2025-08-12T11:05:38.270Z"
Loading
Loading