Jump to >

Diff Context Resource

Added in 2.0

Provides context information for a specific diff view.

The output of this is more or less internal to the Review Board web UI. This will return the various pieces of information required to render a diff view for a given diff revision/interdiff. This is used to re-render the diff viewer without a reload when navigating between revisions.

Details

Name diff_context
URI /api/review-requests/{review_request_id}/diff-context/
Token Policy ID diff_context
HTTP Methods
  • GET - Returns the context info for a particular revision or interdiff.
Parent Resource Review Request Resource
Child Resources None
Anonymous Access Yes, if anonymous site access is enabled

HTTP GET

Returns the context info for a particular revision or interdiff.

The output of this is more or less internal to the Review Board web UI. The result will be an object with several fields for the files in the diff, pagination information, and other data which is used to render the diff viewer page.

Note that in versions 2.0.0 through 2.0.6, the interdiff-revision parameter was named interdiff_revision. Because of the internal nature of this API, this was changed without adding backwards compatibility for 2.0.7.

Request Parameters

filenamesString

A list of case-sensitive filenames or Unix shell patterns used to filter the resulting list of files.

Added in 3.0.4

interdiff-revisionInteger

A tip revision for showing interdiffs. If this is provided, the revision field will be the base diff.

Added in 2.0.7

pageInteger The page number for paginated diffs.
revisionInteger Which revision of the diff to show.

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.