API-Comments

Number of APIs: 4

1. Get an API's comments

GET {{baseUrl}}/apis/{{apiId}}/comments

Gets all comments left by users in an API.

---

2. Create an API comment

POST {{baseUrl}}/apis/{{apiId}}/comments

Creates a comment on an API. Include the following in request body:

• body — (Required) A string that contains the comment.

• tags — An object that contains information about users tagged in the body comment. Include the following in this object:

  • userName — (Required) An object that contains information about the tagged user. The object's name is the user's Qodex username. For example, @user-Qodex. Include the following in this object:

    • type — (Required) A string that contains the user value.
    • id — (Required) An integer that contains the user's ID.

Note:

This endpoint accepts a max of 10,000 characters.

---

3. Update an API's comment

PUT {{baseUrl}}/apis/{{apiId}}/comments/{{commentId}}

Updates a comment on an API. Include the following in request body:

• body — (Required) A string that contains the updated comment.

• tags — An object that contains information about users tagged in the body comment. Include the following in this object:

  • userName — (Required) An object that contains information about the tagged user. The object's name is the user's Qodex username. For example, @user-Qodex. Include the following in this object:

    • type — (Required) A string that contains the user value.
    • id — (Required) An integer that contains the user's ID.

Note:

This endpoint accepts a max of 10,000 characters.

---

4. Delete an API's comment

DELETE {{baseUrl}}/apis/{{apiId}}/comments/{{commentId}}

Deletes a comment from an API. On success, this returns an HTTP 204 No Content response.

Note:

Deleting the first comment of a thread deletes all the comments in the thread.

---