Skip to main content

Get Project

GET /project/:author/:repository/:branch

Get the information of a project.

Path parameters

NameTypeDescription
authorstringThe project author.
repositorystringThe project repository.
branchstringThe project branch.

Response data schema

{
"key": string, // project key, in the format of `author/repository:branch`
"author": string, // project author
"repository": string, // project repository
"branch": string, // project branch
"type": "maven" | "gradle", // project type
"alias"?: string[], // an array of alternative project keys
"buildOptions": BuildOptions, // https://github.com/ybw0014/guizhan-builds-2-data/blob/master/src/ProjectBuildOptions.ts
"displayOptions"?: DisplayOptions, // https://github.com/ybw0014/guizhan-builds-2-data/blob/master/src/ProjectDisplayOptions.ts
}