Review a branch (a comment or an approval; not a gate)

POST

https://app.gitpando.com/v1/monorepos/{owner}/{monorepo}/repos/{repo}/branches/{branch}/reviews

View as Markdown

Authorisation

credentialoptionalHTTP
sessionoptionalAPI key in cookie

Path parameters

ownerstringrequired
The monorepo's owner, a namespace (a person's login or an organization). Matched without case.

pattern: ^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){0,38}$
monorepostringrequired
The monorepo's name within its owner (or an old name). Matched without case.

pattern: ^[a-z0-9](?:[a-z0-9._]|-(?!-)){0,38}$
repostringrequired
The repo's name (projects-web).
branchstringrequired
The branch name, / encoded as %2F.

Request bodyJSONrequired

verdictcommentorrequest_changesorapproverequired
bodyoptionalstring
headoptionalstring
The sha reviewed. Defaults to the branch head now.
commentsoptionalarray ofobject
4 properties
- pathstringrequired
- bodystringrequired
- lineoptionalinteger
  A line in the new file.
- sideoptionalneworold
  Default: "new"

Returns

201

Created

JSON

idstringrequired
branchstringrequired
headstringrequired
verdictcommentorrequest_changesorapproverequired
authorstringrequired
created_atstringrequired
format: date-time
bodyoptionalstring | null
commentsoptionalarray ofobject
4 properties
- pathstringrequired
- bodystringrequired
- lineoptionalinteger
  A line in the new file.
- sideoptionalneworold
  Default: "new"

curl --request POST \ --url https://app.gitpando.com/v1/monorepos/string/string/repos/string/branches/string/reviews \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "verdict": "comment", "body": "string", "head": "string", "comments": [ { "path": "string", "line": 0, "side": "new", "body": "string" } ] } '

{ "id": "string", "branch": "string", "head": "string", "verdict": "comment", "body": "string", "comments": [ { "path": "string", "line": 0, "side": "new", "body": "string" } ], "author": "string", "created_at": "2019-08-24T14:15:22Z" }