This page describes the change related REST endpoints. Please also take note of the general information on the REST API.
Change Endpoints
Query Changes
'GET /changes/'
Queries changes visible to the caller. The query string must be
provided by the q
parameter. The n
parameter can be used to limit
the returned results.
As result a list of ChangeInfo entries is returned. The change output is sorted by the last update time, most recently updated to oldest updated.
Query for open changes of watched projects:
GET /changes/?q=status:open+is:watched&n=2 HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' [ { "kind": "gerritcodereview#change", "id": "demo~master~Idaf5e098d70898b7119f6f4af5a6c13343d64b57", "project": "demo", "branch": "master", "change_id": "Idaf5e098d70898b7119f6f4af5a6c13343d64b57", "subject": "One change", "status": "NEW", "created": "2012-07-17 07:18:30.854000000", "updated": "2012-07-17 07:19:27.766000000", "mergeable": true, "_sortkey": "001e7057000006dc", "_number": 1756, "owner": { "name": "John Doe" }, }, { "kind": "gerritcodereview#change", "id": "demo~master~I09c8041b5867d5b33170316e2abc34b79bbb8501", "project": "demo", "branch": "master", "change_id": "I09c8041b5867d5b33170316e2abc34b79bbb8501", "subject": "Another change", "status": "NEW", "created": "2012-07-17 07:18:30.884000000", "updated": "2012-07-17 07:18:30.885000000", "mergeable": true, "_sortkey": "001e7056000006dd", "_number": 1757, "owner": { "name": "John Doe" }, "_more_changes": true } ]
If the n
query parameter is supplied and additional changes exist
that match the query beyond the end, the last change object has a
_more_changes: true
JSON field set. Callers can resume a query with
the N
query parameter, supplying the last change’s _sortkey
field
as the value. When going in the reverse direction with the P
query
parameter a _more_changes: true
is put in the first change object if
there are results before the first change returned.
Clients are allowed to specify more than one query by setting the q
parameter multiple times. In this case the result is an array of
arrays, one per query in the same order the queries were given in.
Query that retrieves changes for a user’s dashboard:
GET /changes/?q=is:open+owner:self&q=is:open+reviewer:self+-owner:self&q=is:closed+owner:self+limit:5&o=LABELS HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' [ [ { "kind": "gerritcodereview#change", "id": "demo~master~Idaf5e098d70898b7119f6f4af5a6c13343d64b57", "project": "demo", "branch": "master", "change_id": "Idaf5e098d70898b7119f6f4af5a6c13343d64b57", "subject": "One change", "status": "NEW", "created": "2012-07-17 07:18:30.854000000", "updated": "2012-07-17 07:19:27.766000000", "mergeable": true, "_sortkey": "001e7057000006dc", "_number": 1756, "owner": { "name": "John Doe" }, "labels": { "Verified": {}, "Code-Review": {} } } ], [], [] ]
Additional fields can be obtained by adding o
parameters, each
option requires more database lookups and slows down the query
response time to the client so they are generally disabled by
default. Optional fields are:
-
LABELS
: a summary of each label required for submit, and approvers that have granted (or rejected) with that label.
-
DETAILED_LABELS
: detailed label information, including numeric values of all existing approvals, recognized label values, values permitted to be set by the current user, and reviewers that may be removed by the current user.
-
CURRENT_REVISION
: describe the current revision (patch set) of the change, including the commit SHA-1 and URLs to fetch from.
-
ALL_REVISIONS
: describe all revisions, not just current.
-
DOWNLOAD_COMMANDS
: include thecommands
field in the FetchInfo for revisions. Only valid when theCURRENT_REVISION
orALL_REVISIONS
option is selected.
-
DRAFT_COMMENTS
: include thehas_draft_comments
field for revisions. Only valid when theCURRENT_REVISION
orALL_REVISIONS
option is selected.
-
CURRENT_COMMIT
: parse and output all header fields from the commit object, including message. Only valid when theCURRENT_REVISION
orALL_REVISIONS
option is selected.
-
ALL_COMMITS
: parse and output all header fields from the output revisions. If onlyCURRENT_REVISION
was requested then only the current revision’s commit data will be output.
-
CURRENT_FILES
: list files modified by the commit, including basic line counts inserted/deleted per file. Only valid when theCURRENT_REVISION
orALL_REVISIONS
option is selected.
-
ALL_FILES
: list files modified by the commit, including basic line counts inserted/deleted per file. If only theCURRENT_REVISION
was requested then only that commit’s modified files will be output.
-
DETAILED_ACCOUNTS
: include_account_id
,email
andusername
fields when referencing accounts.
-
MESSAGES
: include messages associated with the change.
-
CURRENT_ACTIONS
: include information on available actions for the change and its current revision. The caller must be authenticated to obtain the available actions.
-
REVIEWED
: include thereviewed
field if the caller is authenticated and has commented on the current revision.
GET /changes/?q=97&o=CURRENT_REVISION&o=CURRENT_COMMIT&o=CURRENT_FILES&o=DOWNLOAD_COMMANDS HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' [ { "kind": "gerritcodereview#change", "id": "demo~master~I7ea46d2e2ee5c64c0d807677859cfb7d90b8966a", "project": "gerrit", "branch": "master", "change_id": "I7ea46d2e2ee5c64c0d807677859cfb7d90b8966a", "subject": "Use an EventBus to manage star icons", "status": "NEW", "created": "2012-04-25 00:52:25.580000000", "updated": "2012-04-25 00:52:25.586000000", "mergeable": true, "_sortkey": "001c9bf400000061", "_number": 97, "owner": { "name": "Shawn Pearce" }, "current_revision": "184ebe53805e102605d11f6b143486d15c23a09c", "revisions": { "184ebe53805e102605d11f6b143486d15c23a09c": { "_number": 1, "fetch": { "git": { "url": "git://localhost/gerrit", "ref": "refs/changes/97/97/1", "commands": { "Checkout": "git fetch git://localhost/gerrit refs/changes/97/97/1 \u0026\u0026 git checkout FETCH_HEAD", "Cherry-Pick": "git fetch git://localhost/gerrit refs/changes/97/97/1 \u0026\u0026 git cherry-pick FETCH_HEAD", "Format-Patch": "git fetch git://localhost/gerrit refs/changes/97/97/1 \u0026\u0026 git format-patch -1 --stdout FETCH_HEAD", "Pull": "git pull git://localhost/gerrit refs/changes/97/97/1" } }, "http": { "url": "http://myuser@127.0.0.1:8080/gerrit", "ref": "refs/changes/97/97/1", "commands": { "Checkout": "git fetch http://myuser@127.0.0.1:8080/gerrit refs/changes/97/97/1 \u0026\u0026 git checkout FETCH_HEAD", "Cherry-Pick": "git fetch http://myuser@127.0.0.1:8080/gerrit refs/changes/97/97/1 \u0026\u0026 git cherry-pick FETCH_HEAD", "Format-Patch": "git fetch http://myuser@127.0.0.1:8080/gerrit refs/changes/97/97/1 \u0026\u0026 git format-patch -1 --stdout FETCH_HEAD", "Pull": "git pull http://myuser@127.0.0.1:8080/gerrit refs/changes/97/97/1" } }, "ssh": { "url": "ssh://myuser@*:29418/gerrit", "ref": "refs/changes/97/97/1", "commands": { "Checkout": "git fetch ssh://myuser@*:29418/gerrit refs/changes/97/97/1 \u0026\u0026 git checkout FETCH_HEAD", "Cherry-Pick": "git fetch ssh://myuser@*:29418/gerrit refs/changes/97/97/1 \u0026\u0026 git cherry-pick FETCH_HEAD", "Format-Patch": "git fetch ssh://myuser@*:29418/gerrit refs/changes/97/97/1 \u0026\u0026 git format-patch -1 --stdout FETCH_HEAD", "Pull": "git pull ssh://myuser@*:29418/gerrit refs/changes/97/97/1" } } }, "commit": { "parents": [ { "commit": "1eee2c9d8f352483781e772f35dc586a69ff5646", "subject": "Migrate contributor agreements to All-Projects." } ], "author": { "name": "Shawn O. Pearce", "email": "sop@google.com", "date": "2012-04-24 18:08:08.000000000", "tz": -420 }, "committer": { "name": "Shawn O. Pearce", "email": "sop@google.com", "date": "2012-04-24 18:08:08.000000000", "tz": -420 }, "subject": "Use an EventBus to manage star icons", "message": "Use an EventBus to manage star icons\n\nImage widgets that need to ..." }, "files": { "gerrit-gwtui/src/main/java/com/google/gerrit/client/changes/ChangeCache.java": { "lines_deleted": 8 }, "gerrit-gwtui/src/main/java/com/google/gerrit/client/changes/ChangeDetailCache.java": { "lines_inserted": 1 }, "gerrit-gwtui/src/main/java/com/google/gerrit/client/changes/ChangeScreen.java": { "lines_inserted": 11, "lines_deleted": 19 }, "gerrit-gwtui/src/main/java/com/google/gerrit/client/changes/ChangeTable.java": { "lines_inserted": 23, "lines_deleted": 20 }, "gerrit-gwtui/src/main/java/com/google/gerrit/client/changes/StarCache.java": { "status": "D", "lines_deleted": 139 }, "gerrit-gwtui/src/main/java/com/google/gerrit/client/changes/StarredChanges.java": { "status": "A", "lines_inserted": 204 }, "gerrit-gwtui/src/main/java/com/google/gerrit/client/ui/Screen.java": { "lines_deleted": 9 } } } } } ]
Get Change
'GET /changes/link:#change-id[\{change-id\}]'
Retrieves a change.
Additional fields can be obtained by adding o
parameters, each
option requires more database lookups and slows down the query
response time to the client so they are generally disabled by
default. Fields are described in Query Changes.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940 HTTP/1.0
As response a ChangeInfo entity is returned that describes the change.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#change", "id": "myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940", "project": "myProject", "branch": "master", "change_id": "I8473b95934b5732ac55d26311a706c9c2bde9940", "subject": "Implementing Feature X", "status": "NEW", "created": "2013-02-01 09:59:32.126000000", "updated": "2013-02-21 11:16:36.775000000", "mergeable": true, "_sortkey": "0023412400000f7d", "_number": 3965, "owner": { "name": "John Doe" } }
Get Change Detail
'GET /changes/link:#change-id[\{change-id\}]/detail'
Retrieves a change with labels, detailed labels, detailed accounts, and messages.
Additional fields can be obtained by adding o
parameters, each
option requires more database lookups and slows down the query
response time to the client so they are generally disabled by
default. Fields are described in Query Changes.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/detail HTTP/1.0
As response a ChangeInfo entity is returned that describes the change.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#change", "id": "myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940", "project": "myProject", "branch": "master", "change_id": "I8473b95934b5732ac55d26311a706c9c2bde9940", "subject": "Implementing Feature X", "status": "NEW", "created": "2013-02-01 09:59:32.126000000", "updated": "2013-02-21 11:16:36.775000000", "mergeable": true, "_sortkey": "0023412400000f7d", "_number": 3965, "owner": { "_account_id": 1000096, "name": "John Doe", "email": "john.doe@example.com", "username": "jdoe" }, "labels": { "Verified": { "all": [ { "value": 0, "_account_id": 1000096, "name": "John Doe", "email": "john.doe@example.com", "username": "jdoe" }, { "value": 0, "_account_id": 1000097, "name": "Jane Roe", "email": "jane.roe@example.com", "username": "jroe" } ], "values": { "-1": "Fails", " 0": "No score", "+1": "Verified" } }, "Code-Review": { "recommended": { "_account_id": 1000097, "name": "Jane Roe", "email": "jane.roe@example.com", "username": "jroe" }, "disliked": { "_account_id": 1000096, "name": "John Doe", "email": "john.doe@example.com", "username": "jdoe" }, "all": [ { "value": -1, "_account_id": 1000096, "name": "John Doe", "email": "john.doe@example.com", "username": "jdoe" }, { "value": 1, "_account_id": 1000097, "name": "Jane Roe", "email": "jane.roe@example.com", "username": "jroe" } ] "values": { "-2": "Do not submit", "-1": "I would prefer that you didn\u0027t submit this", " 0": "No score", "+1": "Looks good to me, but someone else must approve", "+2": "Looks good to me, approved" } } }, "permitted_labels": { "Verified": [ "-1", " 0", "+1" ], "Code-Review": [ "-2", "-1", " 0", "+1", "+2" ] }, "removable_reviewers": [ { "_account_id": 1000096, "name": "John Doe", "email": "john.doe@example.com", "username": "jdoe" }, { "_account_id": 1000097, "name": "Jane Roe", "email": "jane.roe@example.com", "username": "jroe" } ], "messages": [ { "id": "YH-egE", "author": { "_account_id": 1000096, "name": "John Doe", "email": "john.doe@example.com", "username": "jdoe" }, "updated": "2013-03-23 21:34:02.419000000", "message": "Patch Set 1:\n\nThis is the first message.", "revision_number": 1 }, { "id": "WEEdhU", "author": { "_account_id": 1000097, "name": "Jane Roe", "email": "jane.roe@example.com", "username": "jroe" }, "updated": "2013-03-23 21:36:52.332000000", "message": "Patch Set 1:\n\nThis is the second message.\n\nWith a line break.", "revision_number": 1 } ] }
Get Topic
'GET /changes/link:#change-id[\{change-id\}]/topic'
Retrieves the topic of a change.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/topic HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' "Documentation"
If the change does not have a topic an empty string is returned.
Set Topic
'PUT /changes/link:#change-id[\{change-id\}]/topic'
Sets the topic of a change.
The new topic must be provided in the request body inside a TopicInput entity.
PUT /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/topic HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "topic": "Documentation" }
As response the new topic is returned.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' "Documentation"
If the topic was deleted the response is "204 No Content
".
Delete Topic
'DELETE /changes/link:#change-id[\{change-id\}]/topic'
Deletes the topic of a change.
The request body does not need to include a TopicInput entity if no review comment is added.
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 topic.
DELETE /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/topic HTTP/1.0
HTTP/1.1 204 No Content
Abandon Change
'POST /changes/link:#change-id[\{change-id\}]/abandon'
Abandons a change.
The request body does not need to include a AbandonInput entity if no review comment is added.
POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/abandon HTTP/1.0
As response a ChangeInfo entity is returned that describes the abandoned change.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#change", "id": "myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940", "project": "myProject", "branch": "master", "change_id": "I8473b95934b5732ac55d26311a706c9c2bde9940", "subject": "Implementing Feature X", "status": "ABANDONED", "created": "2013-02-01 09:59:32.126000000", "updated": "2013-02-21 11:16:36.775000000", "mergeable": true, "_sortkey": "0023412400000f7d", "_number": 3965, "owner": { "name": "John Doe" } }
If the change cannot be abandoned because the change state doesn’t
allow abandoning of the change, the response is "409 Conflict
" and
the error message is contained in the response body.
HTTP/1.1 409 Conflict Content-Disposition: attachment Content-Type: text/plain;charset=UTF-8 change is merged
Restore Change
'POST /changes/link:#change-id[\{change-id\}]/restore'
Restores a change.
The request body does not need to include a RestoreInput entity if no review comment is added.
POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/restore HTTP/1.0
As response a ChangeInfo entity is returned that describes the restored change.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#change", "id": "myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940", "project": "myProject", "branch": "master", "change_id": "I8473b95934b5732ac55d26311a706c9c2bde9940", "subject": "Implementing Feature X", "status": "NEW", "created": "2013-02-01 09:59:32.126000000", "updated": "2013-02-21 11:16:36.775000000", "mergeable": true, "_sortkey": "0023412400000f7d", "_number": 3965, "owner": { "name": "John Doe" } }
If the change cannot be restored because the change state doesn’t
allow restoring the change, the response is "409 Conflict
" and
the error message is contained in the response body.
HTTP/1.1 409 Conflict Content-Disposition: attachment Content-Type: text/plain;charset=UTF-8 change is new
Rebase Change
'POST /changes/link:#change-id[\{change-id\}]/rebase'
Rebases a change.
POST /changes/myProject~master~I3ea943139cb62e86071996f2480e58bf3eeb9dd2/rebase HTTP/1.0
As response a ChangeInfo entity is returned that describes the rebased change. Information about the current patch set is included.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#change", "id": "myProject~master~I3ea943139cb62e86071996f2480e58bf3eeb9dd2", "project": "myProject", "branch": "master", "change_id": "I3ea943139cb62e86071996f2480e58bf3eeb9dd2", "subject": "Implement Feature X", "status": "NEW", "created": "2013-02-01 09:59:32.126000000", "updated": "2013-02-21 11:16:36.775000000", "mergeable": false, "_sortkey": "0024cf9a000012bf", "_number": 4799, "owner": { "name": "John Doe" }, "current_revision": "27cc4558b5a3d3387dd11ee2df7a117e7e581822", "revisions": { "27cc4558b5a3d3387dd11ee2df7a117e7e581822": { "_number": 2, "fetch": { "http": { "url": "http://gerrit:8080/myProject", "ref": "refs/changes/99/4799/2" } }, "commit": { "parents": [ { "commit": "b4003890dadd406d80222bf1ad8aca09a4876b70", "subject": "Implement Feature A" } ], "author": { "name": "John Doe", "email": "john.doe@example.com", "date": "2013-05-07 15:21:27.000000000", "tz": 120 }, "committer": { "name": "Gerrit Code Review", "email": "gerrit-server@example.com", "date": "2013-05-07 15:35:43.000000000", "tz": 120 }, "subject": "Implement Feature X", "message": "Implement Feature X\n\nAdded feature X." } } }
If the change cannot be rebased, e.g. due to conflicts, the response is
"409 Conflict
" and the error message is contained in the response
body.
HTTP/1.1 409 Conflict Content-Disposition: attachment Content-Type: text/plain;charset=UTF-8 The change could not be rebased due to a path conflict during merge.
Revert Change
'POST /changes/link:#change-id[\{change-id\}]/revert'
Reverts a change.
The request body does not need to include a RevertInput entity if no review comment is added.
POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revert HTTP/1.0
As response a ChangeInfo entity is returned that describes the reverting change.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#change", "id": "myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940", "project": "myProject", "branch": "master", "change_id": "I8473b95934b5732ac55d26311a706c9c2bde9940", "subject": "Revert \"Implementing Feature X\"", "status": "NEW", "created": "2013-02-01 09:59:32.126000000", "updated": "2013-02-21 11:16:36.775000000", "mergeable": true, "_sortkey": "0023412400000f7d", "_number": 3965, "owner": { "name": "John Doe" } }
If the change cannot be reverted because the change state doesn’t
allow reverting the change, the response is "409 Conflict
" and
the error message is contained in the response body.
HTTP/1.1 409 Conflict Content-Disposition: attachment Content-Type: text/plain;charset=UTF-8 change is new
Submit Change
'POST /changes/link:#change-id[\{change-id\}]/submit'
Submits a change.
The request body only needs to include a SubmitInput entity if the request should wait for the merge to complete.
POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/submit HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "wait_for_merge": true }
As response a ChangeInfo entity is returned that describes the submitted/merged change.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#change", "id": "myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940", "project": "myProject", "branch": "master", "change_id": "I8473b95934b5732ac55d26311a706c9c2bde9940", "subject": "Implementing Feature X", "status": "MERGED", "created": "2013-02-01 09:59:32.126000000", "updated": "2013-02-21 11:16:36.775000000", "_sortkey": "0023412400000f7d", "_number": 3965, "owner": { "name": "John Doe" } }
If the change cannot be submitted because the submit rule doesn’t allow
submitting the change, the response is "409 Conflict
" and the error
message is contained in the response body.
HTTP/1.1 409 Conflict Content-Disposition: attachment Content-Type: text/plain;charset=UTF-8 blocked by Verified
Publish Draft Change
'POST /changes/link:#change-id[\{change-id\}]/publish'
Publishes a draft change.
POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/publish HTTP/1.0 Content-Type: application/json;charset=UTF-8
HTTP/1.1 204 No Content
Delete Draft Change
'DELETE /changes/link:#change-id[\{change-id\}]'
Deletes a draft change.
DELETE /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940 HTTP/1.0 Content-Type: application/json;charset=UTF-8
HTTP/1.1 204 No Content
Get Included In
'GET /changes/link:#change-id[\{change-id\}]/in'
Retrieves the branches and tags in which a change is included. As result an IncludedInInfo entity is returned.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/in HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#includedininfo", "branches": [ "master" ], "tags": [] }
Reviewer Endpoints
List Reviewers
'GET /changes/link:#change-id[\{change-id\}]/reviewers/'
Lists the reviewers of a change.
As result a list of ReviewerInfo entries is returned.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/reviewers/ HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' [ { "kind": "gerritcodereview#reviewer", "approvals": { "Verified": "+1", "Code-Review": "+2" }, "_account_id": 1000096, "name": "John Doe", "email": "john.doe@example.com" }, { "kind": "gerritcodereview#reviewer", "approvals": { "Verified": " 0", "Code-Review": "-1" }, "_account_id": 1000097, "name": "Jane Roe", "email": "jane.roe@example.com" } ]
Suggest Reviewers
'GET /changes/link:#change-id[\{change-id\}]/suggest_reviewers?q=J&n=5'
Suggest the reviewers for a given query q
and result limit n
. If result
limit is not passed, then the default 10 is used.
As result a list of SuggestedReviewerInfo entries is returned.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/suggest_reviewers?q=J HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' [ { "kind": "gerritcodereview#suggestedreviewer", "account": { "_account_id": 1000097, "name": "Jane Roe", "email": "jane.roe@example.com" } }, { "kind": "gerritcodereview#suggestedreviewer", "group": { "id": "4fd581c0657268f2bdcc26699fbf9ddb76e3a279", "name": "Joiner" } } ]
Get Reviewer
'GET /changes/link:#change-id[\{change-id\}]/reviewers/link:rest-api-accounts.html#account-id[\{account-id\}]'
Retrieves a reviewer of a change.
As response a ReviewerInfo entity is returned that describes the reviewer.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/reviewers/john.doe@example.com HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#reviewer", "approvals": { "Verified": "+1", "Code-Review": "+2" }, "_account_id": 1000096, "name": "John Doe", "email": "john.doe@example.com" }
Add Reviewer
'POST /changes/link:#change-id[\{change-id\}]/reviewers'
Adds one user or all members of one group as reviewer to the change.
The reviewer to be added to the change must be provided in the request body as a ReviewerInput entity.
POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/reviewers HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "reviewer": "john.doe@example.com" }
As response an AddReviewerResult entity is returned that describes the newly added reviewers.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "reviewers": [ { "kind": "gerritcodereview#reviewer", "approvals": { "Verified": " 0", "Code-Review": " 0" }, "_account_id": 1000096, "name": "John Doe", "email": "john.doe@example.com" } ] }
If a group is specified, adding the group members as reviewers is an atomic operation. This means if an error is returned, none of the members are added as reviewer.
If a group with many members is added as reviewer a confirmation may be required.
POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/reviewers HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "reviewer": "MyProjectVerifiers" }
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "error": "The group My Group has 15 members. Do you want to add them all as reviewers?", "confirm": true }
To confirm the addition of the reviewers, resend the request with the
confirmed
flag being set.
POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/reviewers HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "reviewer": "MyProjectVerifiers", "confirmed": true }
Delete Reviewer
'DELETE /changes/link:#change-id[\{change-id\}]/reviewers/link:rest-api-accounts.html#account-id[\{account-id\}]'
Deletes a reviewer from a change.
DELETE /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/reviewers/John%20Doe HTTP/1.0
HTTP/1.1 204 No Content
Revision Endpoints
Get Commit
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/commit'
Retrieves a parsed commit of a revision.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/commit HTTP/1.0
As response a CommitInfo entity is returned that describes the revision.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#commit", "parents": [ { "commit": "1eee2c9d8f352483781e772f35dc586a69ff5646", "subject": "Migrate contributor agreements to All-Projects." } ], "author": { "name": "Shawn O. Pearce", "email": "sop@google.com", "date": "2012-04-24 18:08:08.000000000", "tz": -420 }, "committer": { "name": "Shawn O. Pearce", "email": "sop@google.com", "date": "2012-04-24 18:08:08.000000000", "tz": -420 }, "subject": "Use an EventBus to manage star icons", "message": "Use an EventBus to manage star icons\n\nImage widgets that need to ..." }
Get Review
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/review'
Retrieves a review of a revision.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/review HTTP/1.0
As response a ChangeInfo entity with
detailed labels and
detailed accounts is returned that describes the review of the
revision. The revision for which the review is retrieved is contained
in the revisions
field. In addition the current_revision
field is
set if the revision for which the review is retrieved is the current
revision of the change. Please note that the returned labels are always
for the current patch set.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#change", "id": "myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940", "project": "myProject", "branch": "master", "change_id": "I8473b95934b5732ac55d26311a706c9c2bde9940", "subject": "Implementing Feature X", "status": "NEW", "created": "2013-02-01 09:59:32.126000000", "updated": "2013-02-21 11:16:36.775000000", "mergeable": true, "_sortkey": "0023412400000f7d", "_number": 3965, "owner": { "_account_id": 1000096, "name": "John Doe", "email": "john.doe@example.com" }, "labels": { "Verified": { "all": [ { "value": 0, "_account_id": 1000096, "name": "John Doe", "email": "john.doe@example.com" }, { "value": 0, "_account_id": 1000097, "name": "Jane Roe", "email": "jane.roe@example.com" } ], "values": { "-1": "Fails", " 0": "No score", "+1": "Verified" } }, "Code-Review": { "all": [ { "value": -1, "_account_id": 1000096, "name": "John Doe", "email": "john.doe@example.com" }, { "value": 1, "_account_id": 1000097, "name": "Jane Roe", "email": "jane.roe@example.com" } ] "values": { "-2": "Do not submit", "-1": "I would prefer that you didn\u0027t submit this", " 0": "No score", "+1": "Looks good to me, but someone else must approve", "+2": "Looks good to me, approved" } } }, "permitted_labels": { "Verified": [ "-1", " 0", "+1" ], "Code-Review": [ "-2", "-1", " 0", "+1", "+2" ] }, "removable_reviewers": [ { "_account_id": 1000096, "name": "John Doe", "email": "john.doe@example.com" }, { "_account_id": 1000097, "name": "Jane Roe", "email": "jane.roe@example.com" } ], "current_revision": "674ac754f91e64a0efb8087e59a176484bd534d1", "revisions": { "674ac754f91e64a0efb8087e59a176484bd534d1": { "_number": 2, "fetch": { "http": { "url": "http://gerrit/myProject", "ref": "refs/changes/65/3965/2" } } } }
Set Review
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/review'
Sets a review on a revision.
The review must be provided in the request body as a ReviewInput entity.
POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/review HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "message": "Some nits need to be fixed.", "labels": { "Code-Review": -1 }, "comments": { "gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java": [ { "line": 23, "message": "[nit] trailing whitespace" }, { "line": 49, "message": "[nit] s/conrtol/control" } ] } }
As response a ReviewInfo entity is returned that describes the applied labels.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "labels": { "Code-Review": -1 } }
Rebase Revision
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/rebase'
Rebases a revision.
POST /changes/myProject~master~I3ea943139cb62e86071996f2480e58bf3eeb9dd2/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/rebase HTTP/1.0
As response a ChangeInfo entity is returned that describes the rebased change. Information about the current patch set is included.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#change", "id": "myProject~master~I3ea943139cb62e86071996f2480e58bf3eeb9dd2", "project": "myProject", "branch": "master", "change_id": "I3ea943139cb62e86071996f2480e58bf3eeb9dd2", "subject": "Implement Feature X", "status": "NEW", "created": "2013-02-01 09:59:32.126000000", "updated": "2013-02-21 11:16:36.775000000", "mergeable": false, "_sortkey": "0024cf9a000012bf", "_number": 4799, "owner": { "name": "John Doe" }, "current_revision": "27cc4558b5a3d3387dd11ee2df7a117e7e581822", "revisions": { "27cc4558b5a3d3387dd11ee2df7a117e7e581822": { "_number": 2, "fetch": { "http": { "url": "http://gerrit:8080/myProject", "ref": "refs/changes/99/4799/2" } }, "commit": { "parents": [ { "commit": "b4003890dadd406d80222bf1ad8aca09a4876b70", "subject": "Implement Feature A" } ], "author": { "name": "John Doe", "email": "john.doe@example.com", "date": "2013-05-07 15:21:27.000000000", "tz": 120 }, "committer": { "name": "Gerrit Code Review", "email": "gerrit-server@example.com", "date": "2013-05-07 15:35:43.000000000", "tz": 120 }, "subject": "Implement Feature X", "message": "Implement Feature X\n\nAdded feature X." } } }
If the revision cannot be rebased, e.g. due to conflicts, the response is
"409 Conflict
" and the error message is contained in the response
body.
HTTP/1.1 409 Conflict Content-Disposition: attachment Content-Type: text/plain;charset=UTF-8 The change could not be rebased due to a path conflict during merge.
Submit Revision
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/submit'
Submits a revision.
The request body only needs to include a SubmitInput entity if the request should wait for the merge to complete.
POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/submit HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "wait_for_merge": true }
As response a SubmitInfo entity is returned that describes the status of the submitted change.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "status": "MERGED" }
If the revision cannot be submitted, e.g. because the submit rule
doesn’t allow submitting the revision or the revision is not the
current revision, the response is "409 Conflict
" and the error
message is contained in the response body.
HTTP/1.1 409 Conflict Content-Type: text/plain;charset=UTF-8 "revision 674ac754f91e64a0efb8087e59a176484bd534d1 is not current revision"
Publish Draft Revision
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/publish'
Publishes a draft revision.
POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/current/publish HTTP/1.0 Content-Type: application/json;charset=UTF-8
HTTP/1.1 204 No Content
Delete Draft Revision
'DELETE /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]'
Deletes a draft revision.
DELETE /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1 HTTP/1.0 Content-Type: application/json;charset=UTF-8
HTTP/1.1 204 No Content
Get Patch
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/patch'
Gets the formatted patch for one revision.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/current/patch HTTP/1.0
The formatted patch is returned as text encoded inside base64:
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: text/plain;charset=ISO-8859-1 X-FYI-Content-Encoding: base64 X-FYI-Content-Type: application/mbox RnJvbSA3ZGFkY2MxNTNmZGVhMTdhYTg0ZmYzMmE2ZTI0NWRiYjY...
Adding query parameter zip
(for example /changes/.../patch?zip
)
returns the patch as a single file inside of a ZIP archive. Clients
can expand the ZIP to obtain the plain text patch, avoiding the
need for a base64 decoding step. This option implies download
.
Query parameter download
(e.g. /changes/.../patch?download
)
will suggest the browser save the patch as commitsha1.diff.base64
,
for later processing by command line tools.
Get Mergeable
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/mergeable'
Gets the method the server will use to submit (merge) the change and an indicator if the change is currently mergeable.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/current/mergeable HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { submit_type: "MERGE_IF_NECESSARY", mergeable: true, }
Get Submit Type
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/submit_type'
Gets the method the server will use to submit (merge) the change.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/current/submit_type HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' "MERGE_IF_NECESSARY"
Test Submit Type
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/test.submit_type'
Tests the submit_type Prolog rule in the project, or the one given.
Request body may be either the Prolog code as text/plain
or a
RuleInput object. The query parameter filters
may be set to SKIP
to bypass parent project filters while testing
a project-specific rule.
POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/current/test.submit_type HTTP/1.0 Content-Type: text/plain;charset-UTF-8 submit_type(cherry_pick).
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' "CHERRY_PICK"
Test Submit Rule
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/test.submit_rule'
Tests the submit_rule Prolog rule in the project, or the one given.
Request body may be either the Prolog code as text/plain
or a
RuleInput object. The query parameter filters
may be set to SKIP
to bypass parent project filters while testing
a project-specific rule.
POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/current/test.submit_rule?filters=SKIP HTTP/1.0 Content-Type: text/plain;charset-UTF-8 submit_rule(submit(R)) :- R = label('Any-Label-Name', reject(_)).
The response is a list of SubmitRecord entries describing the permutations that satisfy the tested submit rule.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' [ { "status": "NOT_READY", "reject": { "Any-Label-Name": {} } } ]
List Drafts
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/'
Lists the draft comments of a revision that belong to the calling user.
As result a map is returned that maps the file path to a list of CommentInfo entries. The entries in the map are sorted by file path.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/drafts/ HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java": [ { "kind": "gerritcodereview#comment", "id": "TvcXrmjM", "line": 23, "message": "[nit] trailing whitespace", "updated": "2013-02-26 15:40:43.986000000" }, { "kind": "gerritcodereview#comment", "id": "TveXwFiA", "line": 49, "in_reply_to": "TfYX-Iuo", "message": "Done", "updated": "2013-02-26 15:40:45.328000000" } ] }
Create Draft
'PUT /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts'
Creates a draft comment on a revision.
The new draft comment must be provided in the request body inside a CommentInput entity.
PUT /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/drafts HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "path": "gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java", "line": 23, "message": "[nit] trailing whitespace" }
As response a CommentInfo entity is returned that describes the draft comment.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#comment", "id": "TvcXrmjM", "path": "gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java", "line": 23, "message": "[nit] trailing whitespace", "updated": "2013-02-26 15:40:43.986000000" }
Get Draft
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/link:#draft-id[\{draft-id\}]'
Retrieves a draft comment of a revision that belongs to the calling user.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/drafts/TvcXrmjM HTTP/1.0
As response a CommentInfo entity is returned that describes the draft comment.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#comment", "id": "TvcXrmjM", "path": "gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java", "line": 23, "message": "[nit] trailing whitespace", "updated": "2013-02-26 15:40:43.986000000" }
Update Draft
'PUT /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/link:#draft-id[\{draft-id\}]'
Updates a draft comment on a revision.
The new draft comment must be provided in the request body inside a CommentInput entity.
PUT /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/drafts/TvcXrmjM HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "path": "gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java", "line": 23, "message": "[nit] trailing whitespace" }
As response a CommentInfo entity is returned that describes the draft comment.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#comment", "id": "TvcXrmjM", "path": "gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java", "line": 23, "message": "[nit] trailing whitespace", "updated": "2013-02-26 15:40:43.986000000" }
Delete Draft
'DELETE /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/link:#draft-id[\{draft-id\}]'
Deletes a draft comment from a revision.
DELETE /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/drafts/TvcXrmjM HTTP/1.0
HTTP/1.1 204 No Content
List Comments
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/comments/'
Lists the published comments of a revision.
As result a map is returned that maps the file path to a list of CommentInfo entries. The entries in the map are sorted by file path.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/comments/ HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java": [ { "kind": "gerritcodereview#comment", "id": "TvcXrmjM", "line": 23, "message": "[nit] trailing whitespace", "updated": "2013-02-26 15:40:43.986000000", "author": { "_account_id": 1000096, "name": "John Doe", "email": "john.doe@example.com" } }, { "kind": "gerritcodereview#comment", "id": "TveXwFiA", "line": 49, "in_reply_to": "TfYX-Iuo", "message": "Done", "updated": "2013-02-26 15:40:45.328000000", "author": { "_account_id": 1000097, "name": "Jane Roe", "email": "jane.roe@example.com" } } ] }
Get Comment
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/comments/link:#comment-id[\{comment-id\}]'
Retrieves a published comment of a revision.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/comments/TvcXrmjM HTTP/1.0
As response a CommentInfo entity is returned that describes the published comment.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#comment", "id": "TvcXrmjM", "path": "gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java", "line": 23, "message": "[nit] trailing whitespace", "updated": "2013-02-26 15:40:43.986000000", "author": { "_account_id": 1000096, "name": "John Doe", "email": "john.doe@example.com" } }
List Files
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/'
Lists the files that were modified, added or deleted in a revision.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/files/ HTTP/1.0
As result a map is returned that maps the file path to a list of FileInfo entries. The entries in the map are sorted by file path.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "/COMMIT_MSG": { "status": "A", "lines_inserted": 7 }, "gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java": { "lines_inserted": 5, "lines_deleted": 3 } }
The request parameter reviewed
changes the response to return a list
of the paths the caller has marked as reviewed. Clients that also
need the FileInfo should make two requests.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/files/?reviewed HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' [ "/COMMIT_MSG", "gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java", ]
Get Content
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/content'
Gets the content of a file from a certain revision.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/files/gerrit-server%2Fsrc%2Fmain%2Fjava%2Fcom%2Fgoogle%2Fgerrit%2Fserver%2Fproject%2FRefControl.java/content HTTP/1.0
The content is returned as base64 encoded string.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: text/plain;charset=UTF-8 Ly8gQ29weXJpZ2h0IChDKSAyMDEwIFRoZSBBbmRyb2lkIE9wZW4gU291cmNlIFByb2plY...
Get Diff
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/diff'
Gets the diff of a file from a certain revision.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/files/gerrit-server%2Fsrc%2Fmain%2Fjava%2Fcom%2Fgoogle%2Fgerrit%2Fserver%2Fproject%2FRefControl.java/diff HTTP/1.0
As response a DiffInfo entity is returned that describes the diff.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )] { "meta_a": { "name": "gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java", "content_type": "text/x-java-source" }, "meta_b": { "name": "gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java", "content_type": "text/x-java-source" }, "change_type": "MODIFIED", "diff_header": [ "diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java b/gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java", "index 59b7670..9faf81c 100644", "--- a/gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java", "+++ b/gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java" ], "content": [ { "ab": [ "// Copyright (C) 2010 The Android Open Source Project", "//", "// Licensed under the Apache License, Version 2.0 (the \"License\");", "// you may not use this file except in compliance with the License.", "// You may obtain a copy of the License at", "//", "// http://www.apache.org/licenses/LICENSE-2.0", "//", "// Unless required by applicable law or agreed to in writing, software", "// distributed under the License is distributed on an \"AS IS\" BASIS,", "// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.", "// See the License for the specific language governing permissions and", "// limitations under the License." ] }, { "b": [ "//", "// Add some more lines in the header." ] }, { "ab": [ "", "package com.google.gerrit.server.project;", "", "import com.google.common.collect.Maps;", ... ] } ... ] }
If the intraline
parameter is specified, intraline differences are included in the diff.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/b6b9c10649b9041884046119ab794374470a1b45/files/gerrit-server%2Fsrc%2Fmain%2Fjava%2Fcom%2Fgoogle%2Fgerrit%2Fserver%2Fproject%2FRefControl.java/diff?intraline HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )] { "meta_a": { "name": "gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java", "content_type": "text/x-java-source" }, "meta_b": { "name": "gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java", "content_type": "text/x-java-source" }, "change_type": "MODIFIED", "diff_header": [ "diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java b/gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java", "index 59b7670..9faf81c 100644", "--- a/gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java", "+++ b/gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java" ], "content": [ ... { "a": [ "/** Manages access control for Git references (aka branches, tags). */" ], "b": [ "/** Manages access control for the Git references (aka branches, tags). */" ], "edit_a": [], "edit_b": [ [ 31, 4 ] ] } ] }
The base
parameter can be specified to control the base patch set from which the diff should
be generated.
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/b6b9c10649b9041884046119ab794374470a1b45/files/gerrit-server%2Fsrc%2Fmain%2Fjava%2Fcom%2Fgoogle%2Fgerrit%2Fserver%2Fproject%2FRefControl.java/diff?base=2 HTTP/1.0
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )] { "meta_a": { "name": "gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java", "content_type": "text/x-java-source" }, "meta_b": { "name": "gerrit-server/src/main/java/com/google/gerrit/server/project/RefControl.java", "content_type": "text/x-java-source" }, "change_type": "MODIFIED", "content": [ { "skip": 578 } ] }
The ignore-whitespace
parameter can be specified to control how whitespace differences are
reported in the result. Valid values are NONE
, TRAILING
, CHANGED
or ALL
.
The context
parameter can be specified to control the number of lines of surrounding context
in the diff. Valid values are ALL
or number of lines.
Set Reviewed
'PUT /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/reviewed'
Marks a file of a revision as reviewed by the calling user.
PUT /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/files/gerrit-server%2Fsrc%2Fmain%2Fjava%2Fcom%2Fgoogle%2Fgerrit%2Fserver%2Fproject%2FRefControl.java/reviewed HTTP/1.0
HTTP/1.1 201 Created
If the file was already marked as reviewed by the calling user the
response is "200 OK
".
Delete Reviewed
'DELETE /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/reviewed'
Deletes the reviewed flag of the calling user from a file of a revision.
DELETE /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/files/gerrit-server%2Fsrc%2Fmain%2Fjava%2Fcom%2Fgoogle%2Fgerrit%2Fserver%2Fproject%2FRefControl.java/reviewed HTTP/1.0
HTTP/1.1 204 No Content
Cherry Pick Revision
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/cherrypick'
Cherry picks a revision to a destination branch.
The commit message and destination branch must be provided in the request body inside a CherryPickInput entity.
POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/cherrypick HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "message" : "Implementing Feature X", "destination" : "release-branch" }
As response a ChangeInfo entity is returned that describes the resulting cherry picked change.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#change", "id": "myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9941", "project": "myProject", "branch": "release-branch", "change_id": "I8473b95934b5732ac55d26311a706c9c2bde9941", "subject": "Implementing Feature X", "status": "NEW", "created": "2013-02-01 09:59:32.126000000", "updated": "2013-02-21 11:16:36.775000000", "mergeable": true, "_sortkey": "0023412400000f7d", "_number": 3965, "owner": { "name": "John Doe" } }
Edit Commit Message
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/message'
Edit commit message.
The commit message must be provided in the request body inside a CherryPickInput entity.
POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/message HTTP/1.0 Content-Type: application/json;charset=UTF-8 { "message" : "Reword Implementing Feature X", }
As response a ChangeInfo entity is returned that describes the change.
HTTP/1.1 200 OK Content-Disposition: attachment Content-Type: application/json;charset=UTF-8 )]}' { "kind": "gerritcodereview#change", "id": "myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9941", "project": "myProject", "branch": "release-branch", "change_id": "I8473b95934b5732ac55d26311a706c9c2bde9941", "subject": "Reword Implementing Feature X", "status": "NEW", "created": "2013-02-01 09:59:32.126000000", "updated": "2013-02-21 11:16:36.775000000", "mergeable": true, "_sortkey": "0023412400000f7d", "_number": 3965, "owner": { "name": "John Doe" } }
IDs
{change-id}
Identifier that uniquely identifies one change.
This can be:
-
an ID of the change in the format "<project>~<branch>~<Change-Id>", where for the branch the
refs/heads/
prefix can be omitted ("myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940") -
a Change-Id if it uniquely identifies one change ("I8473b95934b5732ac55d26311a706c9c2bde9940")
-
a legacy numeric change ID ("4247")
{comment-id}
UUID of a published comment.
{draft-id}
UUID of a draft comment.
{file-id}
The path of the file.
{revision-id}
Identifier that uniquely identifies one revision of a change.
This can be:
-
the literal
current
to name the current patch set/revision -
a commit ID ("674ac754f91e64a0efb8087e59a176484bd534d1")
-
an abbreviated commit ID that uniquely identifies one revision of the change ("674ac754"), at least 4 digits are required
-
a legacy numeric patch number ("1" for first patch set of the change)
JSON Entities
AbandonInput
The AbandonInput
entity contains information for abandoning a change.
Field Name | Description | |
---|---|---|
|
optional |
Message to be added as review comment to the change when abandoning the change. |
ActionInfo
The ActionInfo
entity describes a REST API call the client can
make to manipulate a resource. These are frequently implemented by
plugins and may be discovered at runtime.
Field Name | Description | |
---|---|---|
|
optional |
HTTP method to use with the action. Most actions use |
|
optional |
Short title to display to a user describing the action. In the Gerrit web interface the label is used as the text on the button presented in the UI. |
|
optional |
Longer text to display describing the action. In a web UI this should be the title attribute of the element, displaying when the user hovers the mouse. |
|
optional |
If true the action is permitted at this time and the caller is likely allowed to execute it. This may change if state is updated at the server or permissions are modified. Not present if false. |
AddReviewerResult
The AddReviewerResult
entity describes the result of adding a
reviewer to a change.
Field Name | Description | |
---|---|---|
|
optional |
The newly added reviewers as a list of ReviewerInfo entities. |
|
optional |
Error message explaining why the reviewer could not be added. |
|
|
Whether adding the reviewer requires confirmation. |
ApprovalInfo
The ApprovalInfo
entity contains information about an approval from a
user for a label on a change.
ApprovalInfo
has the same fields as
AccountInfo.
In addition ApprovalInfo
has the following fields:
Field Name | Description | |
---|---|---|
|
optional |
The vote that the user has given for the label. If present and zero, the user is permitted to vote on the label. If absent, the user is not permitted to vote on that label. |
|
optional |
The time and date describing when the approval was made. |
GroupBaseInfo
The GroupBaseInfo
entity contains base information about the group.
Field Name | Description |
---|---|
|
The id of the group. |
|
The name of the group. |
ChangeInfo
The ChangeInfo
entity contains information about a change.
Field Name | Description | |
---|---|---|
|
|
|
|
The ID of the change in the format "<project>~<branch>~<Change-Id>",
where project, branch and Change-Id are URL encoded. For branch the
|
|
|
The name of the project. |
|
|
The name of the target branch. |
|
|
optional |
The topic to which this change belongs. |
|
The Change-Id of the change. |
|
|
The subject of the change (header line of the commit message). |
|
|
The status of the change ( |
|
|
The timestamp of when the change was created. |
|
|
The timestamp of when the change was last updated. |
|
|
not set if |
Whether the calling user has starred this change. |
|
not set if |
Whether the change was reviewed by the calling user. Only set if reviewed is requested. |
|
optional |
Whether the change is mergeable. |
|
The sortkey of the change. |
|
|
The legacy numeric ID of the change. |
|
|
The owner of the change as an AccountInfo entity. |
|
|
optional |
Actions the caller might be able to perform on this revision. The information is a map of view name to ActionInfo entities. |
|
optional |
The labels of the change as a map that maps the label names to
LabelInfo entries. |
|
optional |
A map of the permitted labels that maps a label name to the list of
values that are allowed for that label. |
|
optional |
The reviewers that can be removed by the calling user as a list of
AccountInfo entities. |
|
optional |
Messages associated with the change as a list of
ChangeMessageInfo entities. |
|
optional |
The commit ID of the current patch set of this change. |
|
optional |
All patch sets of this change as a map that maps the commit ID of the
patch set to a RevisionInfo entity. |
|
optional, not set if |
Whether the query would deliver more results if not limited. |
ChangeMessageInfo
The ChangeMessageInfo
entity contains information about a message
attached to a change.
Field Name | Description | |
---|---|---|
|
The ID of the message. |
|
|
optional |
Author of the message as an
AccountInfo entity. |
|
The timestamp this message was posted. |
|
|
The text left by the user. |
|
|
optional |
Which patchset (if any) generated this message. |
CherryPickInput
The CherryPickInput
entity contains information for cherry-picking a change to a new branch.
Field Name | Description |
---|---|
|
Commit message for the cherry-picked change |
|
Destination Branch |
CommentInfo
The CommentInfo
entity contains information about an inline comment.
Field Name | Description | |
---|---|---|
|
|
|
|
The URL encoded UUID of the comment. |
|
|
optional |
The path of the file for which the inline comment was done. |
|
optional |
The side on which the comment was added. |
|
optional |
The number of the line for which the comment was done. |
|
optional |
The range of the comment as a CommentRange entity. |
|
optional |
The URL encoded UUID of the comment to which this comment is a reply. |
|
optional |
The comment message. |
|
The timestamp of when this comment was written. |
|
|
optional |
The author of the message as an
AccountInfo entity. |
CommentInput
The CommitInput
entity contains information for creating an inline
comment.
Field Name | Description | |
---|---|---|
|
optional |
Must be |
|
optional |
The URL encoded UUID of the comment if an existing draft comment should be updated. |
|
optional |
The path of the file for which the inline comment should be added. |
|
optional |
The side on which the comment should be added. |
|
optional |
The number of the line for which the comment should be added. |
|
optional |
The range of the comment as a CommentRange entity. |
|
optional |
The URL encoded UUID of the comment to which this comment is a reply. |
|
optional |
The timestamp of this comment. |
|
optional |
The comment message. |
CommentRange
The CommentRange
entity describes the range of an inline comment.
Field Name | Description | |
---|---|---|
|
The start line number of the range. |
|
|
The character position in the start line. |
|
|
The end line number of the range. |
|
|
The character position in the end line. |
CommitInfo
The CommitInfo
entity contains information about a commit.
Field Name | Description |
---|---|
|
The commit ID. |
|
The parent commits of this commit as a list of
CommitInfo entities. In each parent
only the |
|
The author of the commit as a GitPersonInfo entity. |
|
The committer of the commit as a GitPersonInfo entity. |
|
The subject of the commit (header line of the commit message). |
|
The commit message. |
DiffContent
The DiffContent
entity contains information about the content differences
in a file.
Field Name | Description | |
---|---|---|
|
optional |
Content only in the file on side A (deleted in B). |
|
optional |
Content only in the file on side B (added in B). |
|
optional |
Content in the file on both sides (unchanged). |
|
only present during a replace, i.e. both |
Text sections deleted from side A as a DiffIntralineInfo entity. |
|
only present during a replace, i.e. both |
Text sections inserted in side B as a DiffIntralineInfo entity. |
|
optional |
count of lines skipped on both sides when the file is too large to include all common lines. |
DiffFileMetaInfo
The DiffFileMetaInfo
entity contains meta information about a file diff.
Field Name | Description |
---|---|
|
The name of the file. |
|
The content type of the file. |
DiffInfo
The DiffInfo
entity contains information about the diff of a file
in a revision.
Field Name | Description | |
---|---|---|
|
not present when the file is added |
Meta information about the file on side A as a DiffFileMetaInfo entity. |
|
not present when the file is deleted |
Meta information about the file on side B as a DiffFileMetaInfo entity. |
|
The type of change ( |
|
|
only set when the |
Intraline status ( |
|
A list of strings representing the patch set diff header. |
|
|
The content differences in the file as a list of DiffContent entities. |
DiffIntralineInfo
The DiffIntralineInfo
entity contains information about intraline edits in a
file.
The information consists of a list of <skip length, mark length>
pairs, where
the skip length is the number of characters between the end of the previous edit
and the start of this edit, and the mark length is the number of edited characters
following the skip. The start of the edits is from the beginning of the related
diff content lines.
Note that the implied newline character at the end of each line is included in the length calculation, and thus it is possible for the edits to span newlines.
FetchInfo
The FetchInfo
entity contains information about how to fetch a patch
set via a certain protocol.
Field Name | Description | |
---|---|---|
|
The URL of the project. |
|
|
The ref of the patch set. |
|
|
optional |
The download commands for this patch set as a map that maps the command
names to the commands. |
FileInfo
The FileInfo
entity contains information about a file in a patch set.
Field Name | Description | |
---|---|---|
|
optional |
The status of the file (" |
|
not set if |
Whether the file is binary. |
|
optional |
The old file path. |
|
optional |
Number of inserted lines. |
|
optional |
Number of deleted lines. |
GitPersonInfo
The GitPersonInfo
entity contains information about the
author/committer of a commit.
Field Name | Description |
---|---|
|
The name of the author/committer. |
|
The email address of the author/committer. |
|
The timestamp of when this identity was constructed. |
|
The timezone offset from UTC of when this identity was constructed. |
LabelInfo
The LabelInfo
entity contains information about a label on a change, always
corresponding to the current patch set.
There are two options that control the contents of LabelInfo
:
LABELS
and DETAILED_LABELS
.
-
For a quick summary of the state of labels, use
LABELS
. -
For detailed information about labels, including exact numeric votes for all users and the allowed range of votes for the current user, use
DETAILED_LABELS
.
Common fields
Field Name | Description | |
---|---|---|
|
not set if |
Whether the label is optional. Optional means the label may be set, but it’s neither necessary for submission nor does it block submission if set. |
Fields set by LABELS
Field Name | Description | |
---|---|---|
|
optional |
One user who approved this label on the change (voted the maximum value) as an AccountInfo entity. |
|
optional |
One user who rejected this label on the change (voted the minimum value) as an AccountInfo entity. |
|
optional |
One user who recommended this label on the change (voted positively, but not the maximum value) as an AccountInfo entity. |
|
optional |
One user who disliked this label on the change (voted negatively, but not the minimum value) as an AccountInfo entity. |
|
optional |
If |
|
optional |
The voting value of the user who
recommended/disliked this label on the change if it is not
" |
Fields set by DETAILED_LABELS
Field Name | Description | |
---|---|---|
|
optional |
List of all approvals for this label as a list of ApprovalInfo entities. |
|
optional |
A map of all values that are allowed for this
label. The map maps the values (" |
RestoreInput
The RestoreInput
entity contains information for restoring a change.
Field Name | Description | |
---|---|---|
|
optional |
Message to be added as review comment to the change when restoring the change. |
RevertInput
The RevertInput
entity contains information for reverting a change.
Field Name | Description | |
---|---|---|
|
optional |
Message to be added as review comment to the change when reverting the change. |
ReviewInfo
The ReviewInfo
entity contains information about a review.
Field Name | Description |
---|---|
|
The labels of the review as a map that maps the label names to the voting values. |
ReviewInput
The ReviewInput
entity contains information for adding a review to a
revision.
Field Name | Description | |
---|---|---|
|
optional |
The message to be added as review comment. |
|
optional |
The votes that should be added to the revision as a map that maps the label names to the voting values. |
|
optional |
The comments that should be added as a map that maps a file path to a list of CommentInput entities. |
|
|
Whether all labels are required to be within the user’s permitted ranges
based on access controls. |
|
optional |
Draft handling that defines how draft comments are handled that are
already in the database but that were not also described in this
input. |
|
optional |
Notify handling that defines to whom email notifications should be sent
after the review is stored. |
|
optional |
{account-id} the review
should be posted on behalf of. To use this option the caller must
have been granted |
ReviewerInfo
The ReviewerInfo
entity contains information about a reviewer and its
votes on a change.
ReviewerInfo
has the same fields as
AccountInfo and includes
detailed account information.
In addition ReviewerInfo
has the following fields:
Field Name | Description |
---|---|
|
|
|
The approvals of the reviewer as a map that maps the label names to the
approval values (" |
ReviewerInput
The ReviewerInput
entity contains information for adding a reviewer
to a change.
Field Name | Description | |
---|---|---|
|
The ID of one account that
should be added as reviewer or the
ID of one group for which all members should be added as reviewers. |
|
|
optional |
Whether adding the reviewer is confirmed. |
RevisionInfo
The RevisionInfo
entity contains information about a patch set.
Field Name | Description | |
---|---|---|
|
not set if |
Whether the patch set is a draft. |
|
not set if |
Whether the patch set has one or more draft comments by the calling user. Only set if draft comments is requested. |
|
The patch set number. |
|
|
Information about how to fetch this patch set. The fetch information is
provided as a map that maps the protocol name (" |
|
|
optional |
The commit of the patch set as CommitInfo entity. |
|
optional |
The files of the patch set as a map that maps the file names to FileInfo entities. |
|
optional |
Actions the caller might be able to perform on this revision. The information is a map of view name to ActionInfo entities. |
RuleInput
The RuleInput
entity contains information to test a Prolog rule.
Field Name | Description | |
---|---|---|
|
Prolog code to execute instead of the code in |
|
|
|
When |
SuggestedReviewerInfo
The SuggestedReviewerInfo
entity contains information about a reviewer
that can be added to a change (an account or a group).
SuggestedReviewerInfo
has either the account
field that contains
the AccountInfo entity, or
the group
field that contains the
GroupBaseInfo entity.
SubmitInfo
The SubmitInfo
entity contains information about the change status
after submitting.
Field Name | Description |
---|---|
|
The status of the change after submitting, can be |
SubmitInput
The SubmitInput
entity contains information for submitting a change.
Field Name | Description | |
---|---|---|
|
|
Whether the request should wait for the merge to complete. |
SubmitRecord
The SubmitRecord
entity describes results from a submit_rule.
Field Name | Description | |
---|---|---|
|
|
|
|
optional |
Map of labels that are approved; an AccountInfo identifies the voter chosen by the rule. |
|
optional |
Map of labels that are preventing submit; AccountInfo identifies voter. |
|
optional |
Map of labels that need to be given to submit. The value is currently an empty object. |
|
optional |
Map of labels that can be used, but do not affect submit. AccountInfo identifies voter, if the label has been applied. |
|
optional |
Map of labels that should have been in |
|
optional |
When status is RULE_ERROR this message provides some text describing the failure of the rule predicate. |
TopicInput
The TopicInput
entity contains information for setting a topic.
Field Name | Description | |
---|---|---|
|
optional |
The topic. |
|
optional |
Message to be added as review comment to the change when setting the topic. |
IncludedInInfo
The IncludedInInfo
entity contains information about the branches a
change was merged into and tags it was tagged with.
Field Name | Description |
---|---|
|
|
|
The list of branches this change was merged into. Each branch is listed without the refs/head/ prefix. |
|
The list of tags this change was tagged with. Each tag is listed without the refs/tags/ prefix. |
Part of Gerrit Code Review