List Comments

Retrieves comments for an issue

Request

GET

https://api.sourcecraft.tech/repos/{org_slug}/{repo_slug}/issues/{issue_slug}/comments

Path parameters

Name	Description
issue_slug	Type: string Example: ``
org_slug	Type: string Example: ``
repo_slug	Type: string Example: ``

Query parameters

Name	Description
page_size	Type: string<uint64> The maximum number of issues to return. The service may return fewer than this value Example: ``
page_token	Type: string A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters must match the call that provided the page token. Example: ``
sort_by	Type: string Ordering options: comma separated list of fields. For example: "name, created_at" Default sorting order is ascending. To specify descending order for a field, append a "-" prefix; for example: "name, -created_at" Redundant space characters in the syntax are insignificant. "foo, -bar", " foo , -bar", and "foo,bar" are all equivalent. Example: ``

Responses

200 OK

A successful response.

Body

application/json

{
  "issue_comments": [
    {
      "id": "example",
      "body": "example",
      "parent": {
        "id": "example"
      },
      "author": {
        "id": "example",
        "slug": "example"
      },
      "updated_by": null,
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z",
      "reactions": {},
      "attachments": [
        {
          "id": "example"
        }
      ]
    }
  ],
  "next_page_token": "example"
}

Name

Description

issue_comments

Type: IssueComment[]

Example

[
  {
    "id": "example",
    "body": "example",
    "parent": {
      "id": "example"
    },
    "author": {
      "id": "example",
      "slug": "example"
    },
    "updated_by": null,
    "created_at": "2025-01-01T00:00:00Z",
    "updated_at": "2025-01-01T00:00:00Z",
    "reactions": {},
    "attachments": [
      {
        "id": "example"
      }
    ]
  }
]

next_page_token

Type: string

Example: example

IssueCommentEmbedded

Name

Description

Type: string

Example: example

Example

{
  "id": "example"
}

UserEmbedded

Name

Description

Type: string

Example: example

slug

Type: string

Example: example

Example

{
  "id": "example",
  "slug": "example"
}

ReactionCount

Name	Description
count	Type: integer
self_react	Type: boolean

Example

{
  "count": 0,
  "self_react": true
}

IssueComment

Name

Description

attachments

Type: AttachmentEmbedded[]

Example

[
  {
    "id": "example"
  }
]

author

Type: UserEmbedded

Example

{
  "id": "example",
  "slug": "example"
}

body

Type: string

Example: example

created_at

Type: string<date-time>

Example: 2025-01-01T00:00:00Z

Type: string

Example: example

parent

Type: IssueCommentEmbedded

Example

{
  "id": "example"
}

reactions

Type: key is one of Reactions

[additional]

Type: ReactionCount

Example

{
  "count": 0,
  "self_react": true
}

Example

{}

updated_at

Type: string<date-time>

Example: 2025-01-01T00:00:00Z

updated_by

Type: UserEmbedded

Example

{
  "id": "example",
  "slug": "example"
}

Example

{
  "id": "example",
  "body": "example",
  "parent": {
    "id": "example"
  },
  "author": {
    "id": "example",
    "slug": "example"
  },
  "updated_by": null,
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z",
  "reactions": {},
  "attachments": [
    {
      "id": "example"
    }
  ]
}

default

Both Client Errors (4xx) and Server Errors (5xx) are serialized into this scheme

Body

application/json

{
  "error_code": "example",
  "message": "example",
  "request_id": "example",
  "details": {}
}

Name

Description

details

Type: Optional details. Exact structure depends on error_code

[additional]

Type: string

Example: example

Example

{}

error_code

Type: string

Example: example

message

Type: string

Example: example

request_id

Type: string

Example: example

Была ли статья полезна?

Create comment (by Issue ID)

Create comment