This page describes the project related REST endpoints. Please also take note of the general information on the REST API.
Project Endpoints
List Projects
'GET /projects/'
Lists the projects accessible by the caller. This is the same as using the ls-projects command over SSH, and accepts the same options as query parameters.
As result a map is returned that maps the project names to ProjectInfo entries. The entries in the map are sorted by project name.
GET /projects/?d HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "external/bison": { "kind": "gerritcodereview#project", "id": "external%2Fbison", "description": "GNU parser generator" }, "external/gcc": { "kind": "gerritcodereview#project", "id": "external%2Fgcc", }, "external/openssl": { "kind": "gerritcodereview#project", "id": "external%2Fopenssl", "description": "encryption\ncrypto routines" }, "test": { "kind": "gerritcodereview#project", "id": "test", "description": "\u003chtml\u003e is escaped" } }
The /projects/
URL also accepts a prefix string in the p
parameter.
This limits the results to those projects that start with the specified
prefix.
List all projects that start with platform/
:
GET /projects/?p=platform%2F HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "platform/drivers": { "kind": "gerritcodereview#project", "id": "platform%2Fdrivers", }, "platform/tools": { "kind": "gerritcodereview#project", "id": "platform%2Ftools", } }
E.g. this feature can be used by suggestion client UI’s to limit results.
The /projects/
URL also accepts a limit integer in the n
parameter.
This limits the results to show n
projects.
Query the first 25 projects in project list.
GET /projects/?n=25 HTTP/1.0
The /projects/
URL also accepts a start integer in the S
parameter.
The results will skip S
projects from project list.
Query 25 projects starting from index 50.
GET /projects/?n=25&S=50 HTTP/1.0
Get Project
'GET /projects/link:#project-name[\{project-name\}]'
Retrieves a project.
GET /projects/plugins%2Freplication HTTP/1.0
As response a ProjectInfo entity is returned that describes the project.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#project", "id": "plugins%2Freplication", "name": "plugins/replication", "parent": "Public-Plugins", "description": "Copies to other servers using the Git protocol" }
Create Project
'PUT /projects/link:#project-name[\{project-name\}]'
Creates a new project.
In the request body additional data for the project can be provided as ProjectInput.
PUT /projects/MyProject HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "description": "This is a demo project.", "submit_type": "CHERRY_PICK", "owners": [ "MyProject-Owners" ] }
As response the ProjectInfo entity is returned that describes the created project.
HTTP/1.1 201 Created Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#project", "id": "MyProject", "name": "MyProject", "parent": "All-Projects", "description": "This is a demo project." }
Get Project Description
'GET /projects/link:#project-name[\{project-name\}]/description'
Retrieves the description of a project.
GET /projects/plugins%2Freplication/description HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' "Copies to other servers using the Git protocol"
If the project does not have a description an empty string is returned.
Set Project Description
'PUT /projects/link:#project-name[\{project-name\}]/description'
Sets the description of a project.
The new project description must be provided in the request body inside a ProjectDescriptionInput entity.
PUT /projects/plugins%2Freplication/description HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "description": "Plugin for Gerrit that handles the replication.", "commit_message": "Update the project description" }
As response the new project description is returned.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' "Plugin for Gerrit that handles the replication."
If the description was deleted the response is "204 No Content
".
Delete Project Description
'DELETE /projects/link:#project-name[\{project-name\}]/description'
Deletes the description of a project.
The request body does not need to include a ProjectDescriptionInput entity if no commit message is specified.
Please note that some proxies prohibit request bodies for DELETE requests. In this case, if you want to specify a commit message, use PUT to delete the description.
DELETE /projects/plugins%2Freplication/description HTTP/1.0
HTTP/1.1 204 No Content
Get Project Parent
'GET /projects/link:#project-name[\{project-name\}]/parent'
Retrieves the name of a project’s parent project. For the
All-Projects
root project an empty string is returned.
GET /projects/plugins%2Freplication/parent HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' "All-Projects"
Set Project Parent
'PUT /projects/link:#project-name[\{project-name\}]/parent'
Sets the parent project for a project.
The new name of the parent project must be provided in the request body inside a ProjectParentInput entity.
PUT /projects/plugins%2Freplication/parent HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "parent": "Public-Plugins", "commit_message": "Update the project parent" }
As response the new parent project name is returned.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' "Public-Plugins"
Get HEAD
'GET /projects/link:#project-name[\{project-name\}]/HEAD'
Retrieves for a project the name of the branch to which HEAD
points.
GET /projects/plugins%2Freplication/HEAD HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' "refs/heads/master"
Set HEAD
'PUT /projects/link:#project-name[\{project-name\}]/HEAD'
Sets HEAD
for a project.
The new ref to which HEAD
should point must be provided in the
request body inside a HeadInput entity.
PUT /projects/plugins%2Freplication/HEAD HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "ref": "refs/heads/stable" }
As response the new ref to which HEAD
points is returned.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' "refs/heads/stable"
Get Repository Statistics
'GET /projects/link:#project-name[\{project-name\}]/statistics.git'
Return statistics for the repository of a project.
GET /projects/plugins%2Freplication/statistics.git HTTP/1.0
The repository statistics are returned as a RepositoryStatisticsInfo entity.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "number_of_loose_objects": 127, "number_of_loose_refs": 15, "number_of_pack_files": 15, "number_of_packed_objects": 67, "number_of_packed_refs": 0, "size_of_loose_objects": 29466, "size_of_packed_objects": 9646 }
Get Config
'GET /projects/link:#project-name[\{project-name\}]/config'
Gets some configuration information about a project. Note that this
config info is not simply the contents of project.config
; it generally
contains fields that may have been inherited from parent projects.
GET /projects/myproject/config
A ConfigInfo entity is returned that describes the
project configuration. Some fields are only visible to users that have
read access to refs/meta/config
.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#project_config", "description": "demo project", "use_contributor_agreements": { "value": true, "configured_value": "TRUE", "inherited_value": false }, "use_content_merge": { "value": true, "configured_value": "INHERIT", "inherited_value": true }, "use_signed_off_by": { "value": false, "configured_value": "INHERIT", "inherited_value": false }, "require_change_id": { "value": false, "configured_value": "FALSE", "inherited_value": true }, "max_object_size_limit": { "value": "15m", "configured_value": "15m", "inherited_value": "20m" }, "submit_type": "MERGE_IF_NECESSARY", "state": "ACTIVE", "commentlinks": {}, "actions": { "cookbook~hello-project": { "method": "POST", "label": "Say hello", "title": "Say hello in different languages", "enabled": true } } }
Set Config
'PUT /projects/link:#project-name[\{project-name\}]/config'
Sets the configuration of a project.
The new configuration must be provided in the request body as a ConfigInput entity.
PUT /projects/myproject/config HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "description": "demo project", "use_contributor_agreements": "FALSE", "use_content_merge": "INHERIT", "use_signed_off_by": "INHERIT", "require_change_id": "TRUE", "max_object_size_limit": "10m", "submit_type": "REBASE_IF_NECESSARY", "state": "ACTIVE" }
As response the new configuration is returned as a ConfigInfo entity.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#project_config", "use_contributor_agreements": { "value": false, "configured_value": "FALSE", "inherited_value": false }, "use_content_merge": { "value": true, "configured_value": "INHERIT", "inherited_value": true }, "use_signed_off_by": { "value": false, "configured_value": "INHERIT", "inherited_value": false }, "require_change_id": { "value": true, "configured_value": "TRUE", "inherited_value": true }, "max_object_size_limit": { "value": "10m", "configured_value": "10m", "inherited_value": "20m" }, "submit_type": "REBASE_IF_NECESSARY", "state": "ACTIVE", "commentlinks": {} }
Run GC
'POST /projects/link:#project-name[\{project-name\}]/gc'
Run the Git garbage collection for the repository of a project.
POST /projects/plugins%2Freplication/gc HTTP/1.0
The response is the streamed output of the garbage collection.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: text/plain;charset=UTF-8 collecting garbage for "plugins/replication": Pack refs: 100% (21/21) Counting objects: 20 Finding sources: 100% (20/20) Getting sizes: 100% (13/13) Compressing objects: 83% (5/6) Writing objects: 100% (20/20) Selecting commits: 100% (7/7) Building bitmaps: 100% (7/7) Finding sources: 100% (41/41) Getting sizes: 100% (25/25) Compressing objects: 52% (12/23) Writing objects: 100% (41/41) Prune loose objects also found in pack files: 100% (36/36) Prune loose, unreferenced objects: 100% (36/36) done.
Branch Endpoints
List Branches
'GET /projects/link:#project-name[\{project-name\}]/branches/'
List the branches of a project.
As result a list of BranchInfo entries is returned.
GET /projects/work%2Fmy-project/branches/ HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' [ { "ref": "HEAD", "revision": "master" }, { "ref": "refs/meta/config", "revision": "76016386a0d8ecc7b6be212424978bb45959d668" }, { "ref": "refs/heads/master", "revision": "67ebf73496383c6777035e374d2d664009e2aa5c" }, { "ref": "refs/heads/stable", "revision": "64ca533bd0eb5252d2fee83f63da67caae9b4674", "can_delete": true } ]
Get Branch
'GET /projects/link:#project-name[\{project-name\}]/branches/link:#branch-id[\{branch-id\}]'
Retrieves a branch of a project.
GET /projects/work%2Fmy-project/branches/master HTTP/1.0
As response a BranchInfo entity is returned that describes the branch.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "ref": "refs/heads/master", "revision": "67ebf73496383c6777035e374d2d664009e2aa5c" }
Create Branch
'PUT /projects/link:#project-name[\{project-name\}]/branches/link:#branch-id[\{branch-id\}]'
Creates a new branch.
In the request body additional data for the branch can be provided as BranchInput.
PUT /projects/MyProject/branches/stable HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "revision": "76016386a0d8ecc7b6be212424978bb45959d668" }
As response a BranchInfo entity is returned that describes the created branch.
HTTP/1.1 201 Created Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "ref": "refs/heads/stable", "revision": "76016386a0d8ecc7b6be212424978bb45959d668", "can_delete": true }
Delete Branch
'DELETE /projects/link:#project-name[\{project-name\}]/branches/link:#branch-id[\{branch-id\}]'
Deletes a branch.
DELETE /projects/MyProject/branches/stable HTTP/1.0
HTTP/1.1 204 No Content
Child Project Endpoints
List Child Projects
'GET /projects/link:#project-name[\{project-name\}]/children/'
List the direct child projects of a project.
GET /projects/Public-Plugins/children/ HTTP/1.0
As result a list of ProjectInfo entries is returned that describe the child projects.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' [ { "kind": "gerritcodereview#project", "id": "plugins%2Freplication", "name": "plugins/replication", "parent": "Public-Plugins", "description": "Copies to other servers using the Git protocol" }, { "kind": "gerritcodereview#project", "id": "plugins%2Freviewnotes", "name": "plugins/reviewnotes", "parent": "Public-Plugins", "description": "Annotates merged commits using notes on refs/notes/review." }, { "kind": "gerritcodereview#project", "id": "plugins%2Fsingleusergroup", "name": "plugins/singleusergroup", "parent": "Public-Plugins", "description": "GroupBackend enabling users to be directly added to access rules" } ]
To resolve the child projects of a project recursively the parameter
recursive
can be set.
Child projects that are not visible to the calling user are ignored and are not resolved further.
GET /projects/Public-Projects/children/?recursive HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' [ { "kind": "gerritcodereview#project", "id": "gerrit", "name": "gerrit", "parent": "Public-Projects", "description": "Gerrit Code Review" }, { "kind": "gerritcodereview#project", "id": "plugins%2Freplication", "name": "plugins/replication", "parent": "Public-Plugins", "description": "Copies to other servers using the Git protocol" }, { "kind": "gerritcodereview#project", "id": "plugins%2Freviewnotes", "name": "plugins/reviewnotes", "parent": "Public-Plugins", "description": "Annotates merged commits using notes on refs/notes/review." }, { "kind": "gerritcodereview#project", "id": "plugins%2Fsingleusergroup", "name": "plugins/singleusergroup", "parent": "Public-Plugins", "description": "GroupBackend enabling users to be directly added to access rules" }, { "kind": "gerritcodereview#project", "id": "Public-Plugins", "name": "Public-Plugins", "parent": "Public-Projects", "description": "Parent project for plugins/*" } ]
Get Child Project
'GET /projects/link:#project-name[\{project-name\}]/children/link:#project-name[\{project-name\}]'
Retrieves a child project. If a non-direct child project should be
retrieved the parameter recursive
must be set.
GET /projects/Public-Plugins/children/plugins%2Freplication HTTP/1.0
As response a ProjectInfo entity is returned that describes the child project.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#project", "id": "plugins%2Freplication", "name": "plugins/replication", "parent": "Public-Plugins", "description": "Copies to other servers using the Git protocol" }
Dashboard Endpoints
List Dashboards
'GET /projects/link:#project-name[\{project-name\}]/dashboards/'
List custom dashboards for a project.
As result a list of DashboardInfo entries is returned.
List all dashboards for the work/my-project
project:
GET /projects/work%2Fmy-project/dashboards/ HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' [ { "kind": "gerritcodereview#dashboard", "id": "main:closed", "ref": "main", "path": "closed", "description": "Merged and abandoned changes in last 7 weeks", "url": "/dashboard/?title\u003dClosed+changes\u0026Merged\u003dstatus:merged+age:7w\u0026Abandoned\u003dstatus:abandoned+age:7w", "default": true, "title": "Closed changes", "sections": [ { "name": "Merged", "query": "status:merged age:7w" }, { "name": "Abandoned", "query": "status:abandoned age:7w" } ] } ]
Get Dashboard
'GET /projects/link:#project-name[\{project-name\}]/dashboards/link:#dashboard-id[\{dashboard-id\}]'
Retrieves a project dashboard. The dashboard can be defined on that project or be inherited from a parent project.
GET /projects/work%2Fmy-project/dashboards/main:closed HTTP/1.0
As response a DashboardInfo entity is returned that describes the dashboard.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#dashboard", "id": "main:closed", "ref": "main", "path": "closed", "description": "Merged and abandoned changes in last 7 weeks", "url": "/dashboard/?title\u003dClosed+changes\u0026Merged\u003dstatus:merged+age:7w\u0026Abandoned\u003dstatus:abandoned+age:7w", "default": true, "title": "Closed changes", "sections": [ { "name": "Merged", "query": "status:merged age:7w" }, { "name": "Abandoned", "query": "status:abandoned age:7w" } ] }
To retrieve the default dashboard of a project use default
as
dashboard-id.
GET /projects/work%2Fmy-project/dashboards/default HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#dashboard", "id": "main:closed", "ref": "main", "path": "closed", "description": "Merged and abandoned changes in last 7 weeks", "url": "/dashboard/?title\u003dClosed+changes\u0026Merged\u003dstatus:merged+age:7w\u0026Abandoned\u003dstatus:abandoned+age:7w", "default": true, "title": "Closed changes", "sections": [ { "name": "Merged", "query": "status:merged age:7w" }, { "name": "Abandoned", "query": "status:abandoned age:7w" } ] }
Set Dashboard
'PUT /projects/link:#project-name[\{project-name\}]/dashboards/link:#dashboard-id[\{dashboard-id\}]'
Updates/Creates a project dashboard.
Currently only supported for the default
dashboard.
The creation/update information for the dashboard must be provided in the request body as a DashboardInput entity.
PUT /projects/work%2Fmy-project/dashboards/default HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "id": "main:closed", "commit_message": "Define the default dashboard" }
As response the new/updated dashboard is returned as a DashboardInfo entity.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#dashboard", "id": "main:closed", "ref": "main", "path": "closed", "description": "Merged and abandoned changes in last 7 weeks", "url": "/dashboard/?title\u003dClosed+changes\u0026Merged\u003dstatus:merged+age:7w\u0026Abandoned\u003dstatus:abandoned+age:7w", "default": true, "title": "Closed changes", "sections": [ { "name": "Merged", "query": "status:merged age:7w" }, { "name": "Abandoned", "query": "status:abandoned age:7w" } ] }
Delete Dashboard
'DELETE /projects/link:#project-name[\{project-name\}]/dashboards/link:#dashboard-id[\{dashboard-id\}]'
Deletes a project dashboard.
Currently only supported for the default
dashboard.
The request body does not need to include a DashboardInput entity if no commit message is specified.
Please note that some proxies prohibit request bodies for DELETE requests.
DELETE /projects/work%2Fmy-project/dashboards/default HTTP/1.0
HTTP/1.1 204 No Content
IDs
{branch-id}
The name of a branch or HEAD
. The prefix refs/heads/
can be
omitted.
{dashboard-id}
The ID of a dashboard in the format <ref>:<path>.
A special dashboard ID is default
which represents the default
dashboard of a project.
{project-name}
The name of the project.
JSON Entities
BranchInfo
The BranchInfo
entity contains information about a branch.
Field Name | Description | |
---|---|---|
|
The ref of the branch. |
|
|
The revision to which the branch points. |
|
|
|
Whether the calling user can delete this branch. |
BranchInput
The BranchInput
entity contains information for the creation of
a new branch.
Field Name | Description | |
---|---|---|
|
optional |
The name of the branch. The prefix |
|
optional |
The base revision of the new branch. |
ConfigInfo
The ConfigInfo
entity contains information about the effective project
configuration.
Field Name | Description | |
---|---|---|
|
optional |
The description of the project. |
|
optional |
InheritedBooleanInfo that tells whether authors must complete a contributor agreement on the site before pushing any commits or changes to this project. |
|
optional |
InheritedBooleanInfo that tells whether Gerrit will try to perform a 3-way merge of text file content when a file has been modified by both the destination branch and the change being submitted. This option only takes effect if submit type is not FAST_FORWARD_ONLY. |
|
optional |
InheritedBooleanInfo that tells whether each change must contain a Signed-off-by line from either the author or the uploader in the commit message. |
|
optional |
InheritedBooleanInfo that tells whether a valid Change-Id footer in any commit uploaded for review is required. This does not apply to commits pushed directly to a branch or tag. |
|
The max object size limit of this project as a MaxObjectSizeLimitInfo entity. |
|
|
The default submit type of the project, can be |
|
|
optional |
The state of the project, can be |
|
Map with the comment link configurations of the project. The name of
the comment link configuration is mapped to the comment link
configuration, which has the same format as the
commentlink section of |
|
|
optional |
The theme that is configured for the project as a ThemeInfo entity. |
|
optional |
Actions the caller might be able to perform on this project. The information is a map of view names to ActionInfo entities. |
ConfigInput
The ConfigInput
entity describes a new project configuration.
Field Name | Description | |
---|---|---|
|
optional |
The new description of the project. |
|
optional |
Whether authors must complete a contributor agreement on the site
before pushing any commits or changes to this project. |
|
optional |
Whether Gerrit will try to perform a 3-way merge of text file content
when a file has been modified by both the destination branch and the
change being submitted. This option only takes effect if submit type is
not FAST_FORWARD_ONLY. |
|
optional |
Whether each change must contain a Signed-off-by line from either the
author or the uploader in the commit message. |
|
optional |
Whether a valid Change-Id footer in any commit
uploaded for review is required. This does not apply to commits pushed
directly to a branch or tag. |
|
optional |
The max object size
limit of this project as a
MaxObjectSizeLimitInfo entity. |
|
optional |
The default submit type of the project, can be |
|
optional |
The state of the project, can be |
DashboardInfo
The DashboardInfo
entity contains information about a project
dashboard.
Field Name | Description | |
---|---|---|
|
|
|
|
The ID of the dashboard. The ID has the format <ref>:<path>, where ref and path are URL encoded. |
|
|
The name of the project for which this dashboard is returned. |
|
|
The name of the project in which this dashboard is defined.
This is different from |
|
|
The name of the ref in which the dashboard is defined, without the
|
|
|
The path of the file in which the dashboard is defined. |
|
|
optional |
The description of the dashboard. |
|
optional |
Subquery that applies to all sections in the dashboard. |
|
The URL under which the dashboard can be opened in the Gerrit WebUI. |
|
|
not set if |
Whether this is the default dashboard of the project. |
|
optional |
The title of the dashboard. |
|
The list of sections in the dashboard. |
DashboardInput
The DashboardInput
entity contains information to create/update a
project dashboard.
Field Name | Description | |
---|---|---|
|
optional |
URL encoded ID of a dashboard to which this dashboard should link to. |
|
optional |
Message that should be used to commit the change of the dashboard. |
DashboardSectionInfo
The DashboardSectionInfo
entity contains information about a section
in a dashboard.
Field Name | Description |
---|---|
|
The title of the section. |
|
The query of the section. |
HeadInput
The HeadInput
entity contains information for setting HEAD
for a
project.
Field Name | Description |
---|---|
|
The ref to which |
InheritedBooleanInfo
A boolean value that can also be inherited.
Field Name | Description | |
---|---|---|
|
The effective boolean value. |
|
|
The configured value, can be |
|
|
optional |
The boolean value inherited from the parent. |
MaxObjectSizeLimitInfo
The MaxObjectSizeLimitInfo
entity contains information about the
max object size
limit of a project.
Field Name | Description | |
---|---|---|
|
optional |
The effective value of the max object size limit as a formatted string. |
|
optional |
The max object size limit that is configured on the project as a
formatted string. |
|
optional |
The max object size limit that is inherited as a formatted string. |
ProjectDescriptionInput
The ProjectDescriptionInput
entity contains information for setting a
project description.
Field Name | Description | |
---|---|---|
|
optional |
The project description. |
|
optional |
Message that should be used to commit the change of the project
description in the |
ProjectInfo
The ProjectInfo
entity contains information about a project.
Field Name | Description | |
---|---|---|
|
|
|
|
The URL encoded project name. |
|
|
not set if returned in a map where the project name is used as map key |
The name of the project. |
|
optional |
The name of the parent project. |
|
optional |
The description of the project. |
|
optional |
Map of branch names to HEAD revisions. |
ProjectInput
The ProjectInput
entity contains information for the creation of
a new project.
Field Name | Description | |
---|---|---|
|
optional |
The name of the project (not encoded). |
|
optional |
The name of the parent project. |
|
optional |
The description of the project. |
|
|
Whether a permission-only project should be created. |
|
|
Whether an empty initial commit should be created. |
|
optional |
The submit type that should be set for the project
( |
|
optional |
A list of branches that should be initially created. |
|
optional |
A list of groups that should be assigned as project owner. |
|
|
Whether contributor agreements should be used for the project ( |
|
|
Whether the usage of Signed-Off-By footers is required for the
project ( |
|
|
Whether content merge should be enabled for the project ( |
|
|
Whether the usage of Change-Ids is required for the project ( |
|
optional |
Max allowed Git object size for this project. Common unit suffixes of k, m, or g are supported. |
ProjectParentInput
The ProjectParentInput
entity contains information for setting a
project parent.
Field Name | Description | |
---|---|---|
|
The name of the parent project. |
|
|
optional |
Message that should be used to commit the change of the project parent
in the |
RepositoryStatisticsInfo
The RepositoryStatisticsInfo
entity contains information about
statistics of a Git repository.
Field Name | Description |
---|---|
|
Number of loose objects. |
|
Number of loose refs. |
|
Number of pack files. |
|
Number of packed objects. |
|
Number of packed refs. |
|
Size of loose objects in bytes. |
|
Size of packed objects in bytes. |
ThemeInfo
The ThemeInfo
entity describes a theme.
Field Name | Description | |
---|---|---|
|
optional |
The path to the |
|
optional |
The path to the |
|
optional |
The path to the |
Part of Gerrit Code Review