Get a branch's description

GET

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

curl --request GET \
  --url 'https://api-dev.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

Media typeapplication/json

object

branch

required

string

headSha

required

string

status

required

string

Allowed values: ready updating none unavailable failed

description

required

Any of:

object

object

kind

Any of:

string

string

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

null

null

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>

null

null

forSha

required

Any of:

string

string

null

null

model

required

Any of:

string

string

null

null

generatedAt

required

Any of:

unknown

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

Example

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

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"
}