File Diff List Resource¶
Provides information on per-file diffs.
Each of these contains a single, self-contained diff file that applies to exactly one file on a repository.
Details¶
Name | files |
URI | /api/review-requests/{review_request_id}/diffs/{diff_revision}/files/ |
Token Policy ID | file_diff |
HTTP Methods |
|
Parent Resource | Diff Resource |
Child Resources | |
Anonymous Access | Yes, if anonymous site access is enabled |
Links¶
Name | Method | Resource |
---|---|---|
self | GET | File Diff List Resource |
HTTP GET¶
Returns the list of public per-file diffs on the review request.
Each per-file diff has information about the diff. It does not provide the contents of the diff. For that, access the per-file diff’s resource directly and use the correct mimetype.
Request Parameters¶
counts-onlyBoolean | If specified, a single count field is returned with the number of results, instead of the results themselves. |
max-resultsInteger | The maximum number of results to return in this list. By default, this is 25. There is a hard limit of 200; if you need more than 200 results, you will need to make more than one request, using the “next” pagination link. |
startInteger | The 0-based index of the first result in the list. The start index is usually the previous start index plus the number of previous results. By default, this is 0. |
Errors¶
100 - Does Not ExistHTTP 404 - Not Found | Object does not exist |
101 - Permission DeniedHTTP 403 - Forbidden | You don’t have permission for this |
103 - Not Logged InHTTP 401 - Unauthorized | You are not logged in |
105 - Invalid Form DataHTTP 400 - Bad Request | One or more fields had errors |
112 - OAuth2 Missing Scope ErrorHTTP 403 - Forbidden | Your OAuth2 token lacks the necessary scopes for this request. |
113 - OAuth2 Access Denied ErrorHTTP 403 - Forbidden | OAuth2 token access for this resource is prohibited. |
Examples¶
application/vnd.reviewboard.org.files+json¶
$ curl http://reviews.example.com/api10/1/ -H "Accept: application/json"
Vary: Accept, Cookie
Item-Content-Type: application/vnd.reviewboard.org.file+json
Content-Type: application/vnd.reviewboard.org.files+json
ETag: 03ef0b249d9cb7d206fa7d53408898c66c04a432
X-Content-Type-Options: nosniff
{
"files": [],
"links": {
"self": {
"href": "http://reviews.example.com/api10/1/",
"method": "GET"
}
},
"stat": "ok",
"total_results": 0
}