Skip to content

Comments API

This document provides detailed information about the comment-related API endpoints available in the Constellation project.

Authentication

All the next API requests require authentication using a JWT bearer token. You must include the token in the Authorization header of your requests.

Example

To include the JWT token in your request headers, use the following format:

Authorization: Bearer <your-jwt-token>

Obtaining a JWT Token

You can obtain a JWT token by logging in with your credentials. The token will be included in the response from the login endpoint.

Example Request with JWT Token

Here is an example of how to include the JWT token in a request to the /constellations endpoint:

GET /constellations HTTP/1.1
Host: api.example.com
Authorization: Bearer <your-jwt-token>

Create a New Comment

POST /files/{file_uuid}/comments

Create a new comment.

Request Parameters: - file_uuid (path): The unique identifier of the file.

Request Body: 

{
  "content": "string"
}

Response: - 201 Created: Comment successfully created. - 400 Bad Request: Invalid input data.

Response Example 

{
  "comment_uuid": "0000-000000...",
  "content": "string",
  "file_uuid": "string"
}

Get All Comments

GET /files/{file_uuid}/comments

Retrieve all comments for a file.

Request Parameters: - file_uuid (path): The unique identifier of the file.

Response: - 200 OK: Returns a list of comments. - 404 Not Found: File not found.

Response Example 

{
  "comments": [
    {
      "comment_uuid": "0000-000000...",
      "content": "string",
      "file_uuid": "string"
    }
  ]
}

Create a Reply

POST /files/{file_uuid}/comments/{comment_uuid}

Create a reply to a comment.

Request Parameters: - file_uuid (path): The unique identifier of the file. - comment_uuid (path): The unique identifier of the comment.

Request Body: 

{
  "content": "string"
}

Response: - 201 Created: Reply successfully created. - 400 Bad Request: Invalid input data. - 404 Not Found: Comment not found.

Response Example 

{
  "reply_uuid": "0000-000000...",
  "content": "string",
  "comment_uuid": "string"
}

Delete a Comment

DELETE /files/{file_uuid}/comments/{comment_uuid}

Delete a comment.

Request Parameters: - file_uuid (path): The unique identifier of the file. - comment_uuid (path): The unique identifier of the comment.

Response: - 200 OK: Comment successfully deleted. - 404 Not Found: Comment not found.

Response Example 

{
  "message": "Comment deleted"
}

Update a Comment

PUT /files/{file_uuid}/comments/{comment_uuid}

Update a comment.

Request Parameters: - file_uuid (path): The unique identifier of the file. - comment_uuid (path): The unique identifier of the comment.

Request Body: 

{
  "content": "string"
}

Response: - 200 OK: Comment successfully updated. - 400 Bad Request: Invalid input data. - 404 Not Found: Comment not found.

Response Example 

{
  "comment_uuid": "0000-000000...",
  "content": "string",
  "file_uuid": "string"
}