@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api CircleCI REST API
@base https://circleci.com/api/v1
@version v1
@auth ApiKey circle-token in query
@endpoints 22
@hint download_for_search
@toc me(1), projects(1), project(18), recent-builds(1), user(1)

@group me
@endpoint GET /me
@returns(200)

@endgroup

@group projects
@endpoint GET /projects
@returns(200)

@endgroup

@group project
@endpoint GET /project/{username}/{project}
@optional {limit: any, offset: any, filter: any}
@returns(200)

@endpoint POST /project/{username}/{project}
@optional {body: map}
@returns(201)

@endgroup

@group recent-builds
@endpoint GET /recent-builds
@optional {limit: any, offset: any}
@returns(200)

@endgroup

@group project
@endpoint GET /project/{username}/{project}/{build_num}
@returns(200)

@endpoint GET /project/{username}/{project}/{build_num}/artifacts
@returns(200)

@endpoint POST /project/{username}/{project}/{build_num}/retry
@returns(200)

@endpoint POST /project/{username}/{project}/{build_num}/cancel
@returns(200)

@endpoint GET /project/{username}/{project}/{build_num}/tests
@returns(200)

@endpoint POST /project/{username}/{project}/tree/{branch}
@optional {body: map}
@returns(201)

@endpoint POST /project/{username}/{project}/ssh-key
@required {Content-Type: any, body: map}

@endpoint GET /project/{username}/{project}/checkout-key
@returns(200)

@endpoint POST /project/{username}/{project}/checkout-key
@optional {type: str(deploy-key/github-user-key)}
@returns(200)

@endpoint GET /project/{username}/{project}/checkout-key/{fingerprint}
@returns(200)

@endpoint DELETE /project/{username}/{project}/checkout-key/{fingerprint}
@returns(200)

@endpoint DELETE /project/{username}/{project}/build-cache
@returns(200)

@endpoint GET /project/{username}/{project}/envvar
@returns(200)

@endpoint POST /project/{username}/{project}/envvar
@returns(200)

@endpoint GET /project/{username}/{project}/envvar/{name}
@returns(200)

@endpoint DELETE /project/{username}/{project}/envvar/{name}
@returns(200)

@endgroup

@group user
@endpoint POST /user/heroku-key
@errors {403}

@endgroup

@end