Document REST endpoint to retrieve a change with details
Document the '/changes/<change-id>/detail' REST endpoint. Change-Id: I84d667be931e74cbabaca13f466649a826343bee Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
This commit is contained in:
@@ -340,6 +340,131 @@ describes the change.
|
|||||||
}
|
}
|
||||||
----
|
----
|
||||||
|
|
||||||
|
[[get-change-detail]]
|
||||||
|
GET /changes/\{change-id\}/detail (Get Change Detail)
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Retrieves a change with link:#labels[labels], link:#detailed-labels[
|
||||||
|
detailed labels] and link:#detailed-accounts[detailed accounts].
|
||||||
|
|
||||||
|
.Request
|
||||||
|
----
|
||||||
|
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/detail HTTP/1.0
|
||||||
|
----
|
||||||
|
|
||||||
|
As response a link:#change-info[ChangeInfo] entity is returned that
|
||||||
|
describes the change.
|
||||||
|
|
||||||
|
.Response
|
||||||
|
----
|
||||||
|
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",
|
||||||
|
"reviewed": true,
|
||||||
|
"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": {
|
||||||
|
"recommended": {
|
||||||
|
"_account_id": 1000097,
|
||||||
|
"name": "Jane Roe",
|
||||||
|
"email": "jane.roe@example.com"
|
||||||
|
},
|
||||||
|
"disliked": {
|
||||||
|
"_account_id": 1000096,
|
||||||
|
"name": "John Doe",
|
||||||
|
"email": "john.doe@example.com"
|
||||||
|
},
|
||||||
|
"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"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
----
|
||||||
|
|
||||||
|
|
||||||
[[ids]]
|
[[ids]]
|
||||||
IDs
|
IDs
|
||||||
|
Reference in New Issue
Block a user