Comment Resource

Get Comment

HTTP Request

GET /api/comments/{id}

📋 Description: Fetches the details of a specific comment identified by its unique ID, enabling users to review and manage individual feedback within the system.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

CommentDTO

Example Responses

1{
2  "id": 0,
3  "createdBy": "string",
4  "createdAt": "2019-08-24T14:15:22Z",
5  "comment": "string",
6  "parentEntityId": 0,
7  "parentEntityName": "string"
8}

Update Comment

HTTP Request

PUT /api/comments/{id}

📋 Description: Updates the details of a specific comment identified by its unique ID, enabling users to modify feedback or information as necessary to maintain accurate and relevant content.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

CommentDTO

true

Request body containing the updated comment data, including the content and any relevant metadata for the specified comment ID.

Body Parameters

1{
2  "id": 0,
3  "createdBy": "string",
4  "createdAt": "2019-08-24T14:15:22Z",
5  "comment": "string",
6  "parentEntityId": 0,
7  "parentEntityName": "string"
8}

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Delete Comment

HTTP Request

DELETE /api/comments/{id}

📋 Description: Deletes a specific comment identified by its unique ID, facilitating the management of user-generated content and enhancing the overall user experience.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

Get All Comment

HTTP Request

GET /api/comments

📋 Description: Fetches a list of comments associated with the specified resources, enabling users to review and analyze customer feedback efficiently.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "createdBy": "string",
 5    "createdAt": "2019-08-24T14:15:22Z",
 6    "comment": "string",
 7    "parentEntityId": 0,
 8    "parentEntityName": "string"
 9  }
10]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[CommentDTO]

false

none

[Data transfer object representing a user-generated comment, including relevant metadata and associated identifiers, to facilitate communication and feedback within the platform.]

» id

integer(int64)

false

none

Unique identifier for the resource

» createdBy

string

false

none

Username of who created this resource

» createdAt

string(date-time)

false

none

Timestamp when this resource was created

» comment

string

true

none

Textual feedback or observations related to a specific entity, facilitating communication and collaboration within the business context.

» parentEntityId

integer(int64)

true

none

Unique identifier for the parent entity

» parentEntityName

string

true

none

Name of the parent entity

Create Comment

HTTP Request

POST /api/comments

📋 Description: Submits a new comment to the specified resource, enabling users to engage in discussions and provide feedback within the application.

Parameters

Name

In

Type

Required

Description

body

body

CommentDTO

true

Request body containing the details of the comment, including the user ID, content, and associated post ID for effective engagement tracking.

Body Parameters

1{
2  "id": 0,
3  "createdBy": "string",
4  "createdAt": "2019-08-24T14:15:22Z",
5  "comment": "string",
6  "parentEntityId": 0,
7  "parentEntityName": "string"
8}

Responses

Status

Meaning

Description

Schema

201

Created

Created

integer

Example Responses

10

Get Comment By Entity

HTTP Request

GET /api/comments/{entity}/{entityId}

📋 Description: Fetches comments associated with a specified entity and its unique identifier, enabling users to review feedback and insights relevant to that entity.

Parameters

Name

In

Type

Required

Description

entity

path

string

true

Identifier for the specific entity associated with the comments being retrieved, enabling targeted data access within the system.

entityId

path

integer(int64)

true

Unique identifier for the entity

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "createdBy": "string",
 5    "createdAt": "2019-08-24T14:15:22Z",
 6    "comment": "string",
 7    "parentEntityId": 0,
 8    "parentEntityName": "string"
 9  }
10]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[CommentDTO]

false

none

[Data transfer object representing a user-generated comment, including relevant metadata and associated identifiers, to facilitate communication and feedback within the platform.]

» id

integer(int64)

false

none

Unique identifier for the resource

» createdBy

string

false

none

Username of who created this resource

» createdAt

string(date-time)

false

none

Timestamp when this resource was created

» comment

string

true

none

Textual feedback or observations related to a specific entity, facilitating communication and collaboration within the business context.

» parentEntityId

integer(int64)

true

none

Unique identifier for the parent entity

» parentEntityName

string

true

none

Name of the parent entity