GetIssueCommentsList

get issue comments list

Path Parameters

• owner required

  The owner of the repository, generally called "username". The name is not case sensitive.

• repo required

  repository name, the name is not case sensitive

• issue_number required

  issue num

Header Parameters

• Authorization required

  Private token | app token(ats) (needs to start with Bearer plus a space)

Responses

• 200
• 401
• 403

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• Array [
• id string

  id

• url string

  url

• body string

  Comment content（use MD format）

• user object

  id string

  id

  login string

  username

  url string

  user url

  avatar_url string

  avatar_url

  html_url string

  html_url

  type string

  user type - User | Bot

• issue_url string

  issue_url

• html_url string

  issue Comment web url

• created_at string

  created_at

• updated_at string

  updated_at

• ]

[
  {
    "id": "64a2791c36ca86246aed3612",
    "url": "https://api.atomgit.com/repos/test/public01/issues/comments/64a6742ece72b305b44bb8f1",
    "body": "issue Comment content",
    "user": {
      "id": "62c791bede9059102516aa8f",
      "login": "lik0914",
      "url": "https://api.atomgit.com/users/lik0914",
      "avatar_url": "https://xxx.com/uploads/user/1657265547983_3769.png",
      "html_url": "https://atomgit.com/lik0914",
      "type": "User"
    },
    "issue_url": "https://api.atomgit.com/repos/test/public01/issue/1",
    "html_url": "https://atomgit.com/test/public01/issues/1#issuecomment-64a6742ece72b305b44bb8f1",
    "created_at": "2023-07-04T17:03:05+08:00",
    "updated_at": "2023-07-04T17:03:05+08:00"
  }
]

Invalid token, please check if the token is correct.

application/json

• Schema
• Example (from schema)

---

Schema

• error string

  error name

• error_description string

  wrong description

{
  "error": "invalid_token",
  "error_description": "Invalid token, please provide correct token"
}

application/xml

• Schema
• Example (from schema)

---

Schema

• error string

  error name

• error_description string

  wrong description

<root>
  <error>invalid_token</error>
  <error_description>Invalid token, please provide correct token</error_description>
</root>

Permission exception

application/json

• Schema
• Example (from schema)

---

Schema

• error_code string

  error name

• error_message string

  wrong description

{
  "error_code": "string",
  "error_message": "string"
}

Loading...