opendev/gerrit
Code Issues Proposed changes

Correct Javadoc of RestReadView in extension API

Browse Source 
The resource parameter specifies the resource to be read,
not the resource to be modified.

Change-Id: I4010674a348cefad02c234118ff25cf332dd76b4
This commit is contained in:
David Pursehouse
2014-04-04 18:34:37 +09:00
parent 3c666334c9
commit 503d9b2b33
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
gerrit-extension-api/src/main/java/com/google/gerrit/extensions/restapi/RestReadView.java
View File

@@ -23,7 +23,7 @@ public interface RestReadView<R extends RestResource> extends RestView<R> {
/**
* Process the view operation by reading from the resource.
*
* @param resource resource to modify.
* @param resource resource to read.
* @return result to return to the client. Use {@link BinaryResult} to avoid
* automatic conversion to JSON.
* @throws AuthException the client is not permitted to access this view.