Get a branch's description

GET

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

const url = 'https://api.wrktr.com/api/orgs/example/projects/example/description?branch=example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

What the branch does, as the review agent describes it: a title, a summary, the changes by area, risks and how to check it.

Authorizations

bearer
None

Parameters

Path Parameters

org

required

string

project

required

string

Query Parameters

branch

required

string

Responses

200

BranchDescription

application/json

object

branch

required

string

headSha

required

string

status

required

string

Allowed values: ready updating none unavailable failed

description

required

Any of:

object
null

object

kind

Any of:

string
null

string

Allowed values: feat fix refactor perf docs test ci build chore

title

required

string

summary

required

string

changes

required

Array<object>

object

area

required

string

detail

required

string

risks

required

Array<string>

testNotes

required

Array<string>

forSha

required

Any of:

string
null

string

model

required

Any of:

string
null

string

generatedAt

required

Any of:

unknown
null

Any of:

number
string

number

Example

{
  "status": "ready",
  "description": {
    "kind": "feat"
  },
  "generatedAt": "Infinity"
}

401

Unauthorized

application/json

object

_tag

required

string

Allowed values: Unauthorized

message

required

string

Example

{
  "_tag": "Unauthorized"
}

404

ProjectNotFound | BranchNotFound

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ProjectNotFound

project

required

string

Example

{
  "_tag": "ProjectNotFound"
}