List a branch's comments

GET

/api/orgs/{org}/projects/{project}/comments

curl --request GET \
  --url 'https://api-dev.wrktr.com/api/orgs/example/projects/example/comments?branch=example' \
  --header 'Authorization: Bearer <token>'

Its review threads and replies, re-anchored to the branch head.

Authorizations

• bearer
• None

Parameters

Path Parameters

org

required

string

project

required

string

Query Parameters

branch

required

string

Responses

200

BranchComments

Media typeapplication/json

object

branch

required

string

headSha

required

string

comments

required

Array<object>

object

id

required

string

branch

required

string

path

required

string

line

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

anchorSha

required

string

lineText

required

string

body

required

string

author

required

string

authorKind

required

string

Allowed values: human agent

parentId

required

Any of:

string

string

null

null

status

required

string

Allowed values: open resolved outdated

reviewId

required

Any of:

string

string

null

null

resolvedSha

required

Any of:

string

string

null

null

createdAt

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

updatedAt

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

severity

required

Any of:

string

string

Allowed values: blocker issue nit

null

null

Example

{
  "comments": [
    {
      "line": "Infinity",
      "authorKind": "human",
      "status": "open",
      "createdAt": "Infinity",
      "updatedAt": "Infinity",
      "severity": "blocker"
    }
  ]
}

401

Unauthorized

Media typeapplication/json

object

_tag

required

string

Allowed values: Unauthorized

message

required

string

Example

{
  "_tag": "Unauthorized"
}

404

ProjectNotFound | BranchNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ProjectNotFound

project

required

string

object

object

_tag

required

string

Allowed values: BranchNotFound

project

required

string

branch

required

string

Example

{
  "_tag": "ProjectNotFound"
}