Get all comments of a specific enterprise Issue¶

GET /api/v5/enterprises/{enterprise}/issues/{number}/comments

This endpoint retrieves all comments of an issue under the specified enterprise and supports paginated queries. The results include the content, creation and update times of each comment, information about the issue the comment is associated with, and information about the user who posted the comment.

Access token support¶

• AtomGit user access token (AtomGit user access tokens)

Anonymous access¶

This endpoint allows anonymous access.

Request parameters¶

Response parameters¶

The response body is an array of comment objects. Each array element contains the comment content, the issue associated with the comment, and information about the user who posted the comment.

comment object (array element)

comment.target object¶

comment.target.issue object¶

comment.user object¶

Error responses¶

This endpoint returns an error response when parameters are invalid or the resource does not exist. The error field names are subject to the actual backend response.

400 Invalid parameters

{
  "error": "invalid_request",
  "message": "Invalid parameters"
}

404 Resource not found

{
  "error": "not_found",
  "message": "Enterprise or issue not found"
}

HTTP status codes¶

Request example¶

Parameter notes¶

Replace <enterprise> with the address path of the enterprise/organization (the address path of the namespace that owns the repository); replace <number> with the globally unique ID of the issue. This endpoint allows anonymous access; you can also pass the access_token query parameter for authentication.

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/enterprises/<enterprise>/issues/<number>/comments?page=1&per_page=20' -H 'Accept: application/json'

JavaScript¶

const response = await fetch("https://api.atomgit.com/api/v5/enterprises/<enterprise>/issues/<number>/comments?page=1&per_page=20", {
  headers: {
    "Accept": "application/json",
  },
});

if (!response.ok) {
  throw new Error(`Request failed: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python¶

import requests

resp = requests.get(
    "https://api.atomgit.com/api/v5/enterprises/<enterprise>/issues/<number>/comments",
    params={"page": 1, "per_page": 20},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

Response example¶

Status code: 200

[
  {
    "body": "etst",
    "created_at": "2024-12-10T16:02:21+08:00",
    "id": 1535981,
    "target": {
      "issue": {
        "id": 471521,
        "iid": 1,
        "title": "bbbbb"
      }
    },
    "updated_at": "2024-12-10T16:02:21+08:00",
    "user": {
      "id": 287,
      "login": "csdn_fenglh",
      "name": "fenglh",
      "type": "User"
    }
  }
]

Error codes¶