Comment on a branch

POST

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

curl --request POST \
  --url https://api.wrktr.com/api/orgs/example/projects/example/comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "example", "body": "example", "headSha": "example", "path": "example", "line": "Infinity", "parentId": "example", "authorKind": "human" }'

Start a thread on a line (path, line, and the headSha the line number refers to), or reply to one (parentId).

Authorizations

• bearer

Parameters

Path Parameters

org

required

string

project

required

string

Request Body^required

Media typeapplication/json

object

branch

required

string

body

required

string

>= 1 characters

headSha

Any of:

string

string

null

null

path

Any of:

string

string

null

null

line

Any of:

unknown

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

parentId

Any of:

string

string

null

null

authorKind

Any of:

string

string

Allowed values: human agent

null

null

Responses

200

Comment

Media typeapplication/json

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

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

400

BadRequest

Media typeapplication/json

object

_tag

required

string

Allowed values: BadRequest

Example

{
  "_tag": "BadRequest"
}

401

Unauthorized

Media typeapplication/json

object

_tag

required

string

Allowed values: Unauthorized

message

required

string

Example

{
  "_tag": "Unauthorized"
}

404

ProjectNotFound | BranchNotFound | CommentNotFound

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

object

object

_tag

required

string

Allowed values: CommentNotFound

id

required

string

Example

{
  "_tag": "ProjectNotFound"
}

422

LineNotFound

Media typeapplication/json

object

_tag

required

string

Allowed values: LineNotFound

path

required

string

line

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

Example

{
  "_tag": "LineNotFound",
  "line": "Infinity"
}