Create Comment

POST

1 curl -X POST https://api.gov.nominal.io/api/comments/v1/comments \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "parent": {
6     "type": "resource",
7     "resource": {
8       "resourceType": "RUN",
9       "resourceRid": "resourceRid"
10     }
11   },
12   "content": "content",
13   "attachments": [
14     "attachments"
15   ]
16 }'

Play

200Successful

1 {
2   "rid": "rid",
3   "parent": {
4     "type": "resource",
5     "resource": {
6       "resourceType": "RUN",
7       "resourceRid": "resourceRid"
8     }
9   },
10   "authorRid": "authorRid",
11   "createdAt": "2024-01-15T09:30:00Z",
12   "content": "content",
13   "reactions": [
14     {
15       "rid": "rid",
16       "userRid": "userRid",
17       "createdAt": "2024-01-15T09:30:00Z",
18       "type": "LIKE"
19     },
20     {
21       "rid": "rid",
22       "userRid": "userRid",
23       "createdAt": "2024-01-15T09:30:00Z",
24       "type": "LIKE"
25     }
26   ],
27   "attachments": [
28     "attachments"
29   ],
30   "editedAt": "2024-01-15T09:30:00Z",
31   "deletedAt": "2024-01-15T09:30:00Z",
32   "pinnedBy": "pinnedBy",
33   "pinnedAt": "2024-01-15T09:30:00Z"
34 }

Create a comment on a resource

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

parentobjectRequired

contentstringRequired

The content of the comment. Markdown supported.

attachmentsset of stringsRequired

Attachments to the comment.

Response

This endpoint returns an object.

ridstring

Unique resource identifier for the comment

parentobject

The parent of the comment. It can be a resource or another comment.

authorRidstring

The user who authored the comment

createdAtdatetime

The time the comment was created

contentstring

The markdown content of the comment.

reactionslist of objects

The reactions on the comment

attachmentsset of strings

The comment’s attachments

editedAtdatetimeOptional

The time the comment was edited. Empty if the comment has not been edited.

deletedAtdatetimeOptional

The time the comment was deleted. Empty if the comment has not been deleted.

pinnedBystringOptional

The user who pinned the comment. Empty if the comment is not pinned.

pinnedAtdatetimeOptional

The time the comment was pinned. Empty if the comment is not pinned.