opendev/gerrit
Code Issues Proposed changes

Split REST API documentation and have one page per top level resource

Browse Source 
The documentation page that describes the REST API grew quite big as
more and more REST endpoints were implemented and it is expected that
the REST API documentation will grow further. Having all the REST API
documentation on a single page gets difficult to manage and the
overview gets lost for the readers.

Split the REST API documentation into multiple files so that there is
one page per top level resource that describes the REST endpoints that
are available for that resource.

Change-Id: Ibfd70b95ce3ba6c7d8f78e2db4e9ab05617dde13
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
This commit is contained in:
Edwin Kempin
2013-01-23 16:32:59 +01:00
parent 0a3018492a
commit d0a6392ba9
6 changed files with 638 additions and 578 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
ReleaseNotes/ReleaseNotes-2.5.txt
View File

@@ -270,11 +270,11 @@ ad-hoc scripting use cases.
* link:http://gerrit-documentation.googlecode.com/svn/Documentation/2.5/rest-api.html[Documentation of the REST API]
* Support REST endpoints to
** link:http://gerrit-documentation.googlecode.com/svn/Documentation/2.5/rest-api.html#changes[query changes]
** link:http://gerrit-documentation.googlecode.com/svn/Documentation/2.5/rest-api.html#projects[list projects]
** link:http://gerrit-documentation.googlecode.com/svn/Documentation/2.5/rest-api.html#suggest-projects[suggest
** link:http://gerrit-documentation.googlecode.com/svn/Documentation/2.5/rest-api-changes.html[query changes]
** link:http://gerrit-documentation.googlecode.com/svn/Documentation/2.5/rest-api-projects.html[list projects]
** link:http://gerrit-documentation.googlecode.com/svn/Documentation/2.5/rest-api-projects.html#suggest-projects[suggest
projects]
** link:http://gerrit-documentation.googlecode.com/svn/Documentation/2.5/rest-api.html#accounts_self_capabilities[query
** link:http://gerrit-documentation.googlecode.com/svn/Documentation/2.5/rest-api-accounts.html#accounts_self_capabilities[query
the global capabilities of the calling user]
* Support link:http://gerrit-documentation.googlecode.com/svn/Documentation/2.5/rest-api.html#authentication[anonymous
@@ -1376,7 +1376,7 @@ read every other reference in the repository.
* Avoid second remote call to lookup approvals when loading change
results
+
By using the new link:http://gerrit-documentation.googlecode.com/svn/Documentation/2.5/rest-api.html#changes[`/changes/`]
By using the new link:http://gerrit-documentation.googlecode.com/svn/Documentation/2.5/rest-api-changes.html[`/changes/`]
REST endpoint the web UI client now obtains the label information
during the query and avoids a second round trip to lookup the current
approvals for each displayed change. For most users this should improve