Diff File Attachment Resource¶
Provides information on file attachments associated with files in diffs.
The list of file attachments are tied to files either committed to the repository or proposed in diffs to a review request on the repository. All are associated with a file in a diff.
Files that are newly introduced in a diff and do not have a revision as
of that diff will have the added_in_filediff link set, and
repository_revision will be null.
Details¶
| Name | diff_file_attachment |
| URI | /api/repositories/{repository_id}/diff-file-attachments/{file_attachment_id}/ |
| HTTP Methods |
|
| Parent Resource | Diff File Attachment List Resource |
| Child Resources | None |
| Anonymous Access | Yes, if anonymous site access is enabled |
Fields¶
| absolute_urlString | The absolute URL of the file, for downloading purposes. Added in 2.0 |
| added_in_filediffFile Diff Resource | The file diff that introduced this file. If set, this file is just part of a proposed change, and not necessarily committed in the repository. |
| captionString | The file’s descriptive caption. |
| filenameString | The name of the file. |
| icon_urlString | The URL to a 24x24 icon representing this file. |
| idInteger | The numeric ID of the file. |
| mimetypeString | The mimetype for the file. |
| repository_file_pathString | The file path inside the repository that this file attachment represents. |
| repository_revisionString | The revision that introduced this version of the file, if committed in the repository. |
| review_urlString | The URL to a review UI for this file. |
| thumbnailString | A thumbnail representing this file. |
| urlString | Deprecated The URL of the file, for downloading purposes. If this is not an absolute URL, then it’s relative to the Review Board server’s URL. This is deprecated and will be removed in a future version. Deprecated in 2.0 |
Links¶
| Name | Method | Resource |
|---|---|---|
| self | GET | Diff File Attachment Resource |
HTTP GET¶
Returns the serialized object for the resource.
This will require login if anonymous access isn’t enabled on the site.
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 |
Examples¶
application/vnd.reviewboard.org.diff-file-attachment+json¶
$ curl http://reviews.example.com/api/repositories/1/diff-file-attachments/2/ -H "Accept: application/json"
Vary: Accept, Cookie
ETag: ed79ec0fd6c5276ba665335fc04bb5eb65032467
Content-Type: application/vnd.reviewboard.org.diff-file-attachment+json
X-Content-Type-Options: nosniff
{
"diff_file_attachment": {
"absolute_url": "http://example.com/media/uploaded/files/2013/09/06/98e2a2c1-2c97-4d65-af27-d426ca6ae2d3__image1.png",
"added_in_filediff": null,
"caption": "Sprite Sheet",
"filename": "spritesheet.png",
"icon_url": "/static/rb/images/mimetypes/image-x-generic.png",
"id": 2,
"links": {
"self": {
"href": "http://reviews.example.com/api/repositories/1/diff-file-attachments/2/",
"method": "GET"
}
},
"mimetype": "image/png",
"repository_file_path": "/images/spritesheet.png",
"repository_revision": "123",
"review_url": "/r/9/file/2/",
"thumbnail": "<img src=\"/media/uploaded/files/2013/09/06/98e2a2c1-2c97-4d65-af27-d426ca6ae2d3__image1_400x100.png\" data-at2x=\"/media/uploaded/files/2013/09/06/98e2a2c1-2c97-4d65-af27-d426ca6ae2d3__image1_800x200.png\" class=\"file-thumbnail\" alt=\"Sprite Sheet\" />",
"url": "http://example.com/media/uploaded/files/2013/09/06/98e2a2c1-2c97-4d65-af27-d426ca6ae2d3__image1.png"
},
"stat": "ok"
}