opendev/gerrit
Code Issues Proposed changes
035ac8f3c8
gerrit/Documentation
History
Shawn O. Pearce ea6d0b5a27 Implement new /changes/{id}/action style REST API 
All existing JSON APIs are converted to this new style.

/changes/{id} parses the id field from a JSON response from a prior
response and uses that to uniquely identify a change and verify the
caller can see it. If the user requests only /changes/{id}/ then the
data is returned as a single JSON object.

This commit also gives full remote control of plugins using the
/plugins/ namespace:

  PUT /plugins/{name}    (JAR as request body)
  POST /plugins/{name}   (JSON object {url:"https://..."})
  DELETE /plugins/{name}
  GET /plugins/{name}/gerrit~status
  POST /plugins/{name}/gerrit~reload
  POST /plugins/{name}/gerrit~enable
  POST /plugins/{name}/gerrit~disable

The commit provides some project admin commands:

  GET /projects/{name}/description
  PUT /projects/{name}/description

  GET /projects/{name}/parent
  PUT /projects/{name}/parent

Project dashboards have moved:

  GET /projects/{name}/dashboards
  GET /projects/{name}/dashboards/{id}
  GET /projects/{name}/dashboards/default

To access project names containing /, the name must be encoded with
URL encoding, translating / to %2F.

Change-Id: I6a38902ee473003ec637758b7c911f926a2e948a
2012-11-16 12:00:24 -08:00
..
images First Cut of Gerrit Walkthrough Introduction documentation. 2011-12-28 12:33:39 -07:00
.gitignore Move documentation to gerrit.googlecode.com website 2009-01-29 08:53:07 -08:00
access-control.txt Make the ability to edit topic names a grantable permission 2012-11-16 03:57:12 +09:00
asciidoc.conf Put a link back to the index in every page footer 2009-05-28 15:55:01 -07:00
cmd-ban-commit.txt Add SSH command to ban commits 2012-03-30 16:12:42 +02:00
cmd-cherry-pick.txt Specify output file for curl commands in documentation 2012-07-09 11:34:59 +02:00
cmd-create-account.txt Update HTTP password from SSH commands. 2012-09-13 09:15:02 +02:00
cmd-create-group.txt Fix and complete synopsis of commands in documentation 2012-07-16 13:53:22 +02:00
cmd-create-project.txt Fix and complete synopsis of commands in documentation 2012-07-16 13:53:22 +02:00
cmd-flush-caches.txt Access control documentation: Flush caches capability 2012-03-21 17:43:29 +01:00
cmd-gsql.txt Minor documentation formatting and white space errors fixed 2012-10-21 16:27:18 -07:00
cmd-hook-commit-msg.txt Documentation: commit message hook file should be executable 2012-08-17 09:46:38 +02:00
cmd-index.txt Add ssh command "test-submit-rule" 2012-10-10 15:34:34 +02:00
cmd-kill.txt Access control documentation: Kill and priority capabilities 2012-03-21 17:43:29 +01:00
cmd-ls-groups.txt Fix and complete synopsis of commands in documentation 2012-07-16 13:53:22 +02:00
cmd-ls-projects.txt ls-projects: Add option to list projects on which a certain group is used 2012-08-31 15:53:04 +02:00
cmd-plugin-enable.txt Add ssh command to enable plugins 2012-07-26 16:24:47 -05:00
cmd-plugin-install.txt Document SSH commands gerrit plugin {ls|install|remove|reload} 2012-07-17 16:07:02 +02:00
cmd-plugin-ls.txt Document SSH commands gerrit plugin {ls|install|remove|reload} 2012-07-17 16:07:02 +02:00
cmd-plugin-reload.txt Document that on reload of a plugin a new plugin configuration gets active 2012-07-18 12:48:36 +02:00
cmd-plugin-remove.txt Document SSH commands gerrit plugin {ls|install|remove|reload} 2012-07-17 16:07:02 +02:00
cmd-query.txt Add author and size information to output of query. 2012-10-11 16:03:39 +02:00
cmd-receive-pack.txt Fix and complete synopsis of commands in documentation 2012-07-16 13:53:22 +02:00
cmd-rename-group.txt Add new SSH command to rename groups 2011-10-27 00:28:11 +02:00
cmd-review.txt cmd-review.txt: Add clarification in documentation of --force-message 2012-07-24 13:17:47 +02:00
cmd-set-account.txt Update HTTP password from SSH commands. 2012-09-13 09:15:02 +02:00
cmd-set-project-parent.txt Support to reparent all children of a parent project 2011-11-16 09:34:26 +01:00
cmd-set-project.txt Permit booleans in project.config to be inherited 2012-10-25 11:20:47 -07:00
cmd-set-reviewers.txt Fix and complete synopsis of commands in documentation 2012-07-16 13:53:22 +02:00
cmd-show-caches.txt Fix link in show caches documentation 2012-03-26 13:23:12 +02:00
cmd-show-connections.txt Fix and complete synopsis of commands in documentation 2012-07-16 13:53:22 +02:00
cmd-show-queue.txt Access control documentation: Capability view conn. & queue 2012-03-28 17:34:33 +02:00
cmd-stream-events.txt Send event to stream and execute hook when merge fails 2012-10-17 17:34:14 +09:00
cmd-suexec.txt documentation: Clean up command line documentation, examples 2011-06-14 16:50:19 -07:00
cmd-test-submit-rule.txt Add ssh command "test-submit-rule" 2012-10-10 15:34:34 +02:00
cmd-version.txt Add missing documentation of SSH "version" command 2012-09-25 12:26:52 -04:00
config-contact.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
config-gerrit.txt Merge "Caching of changes" 2012-10-22 09:54:30 -07:00
config-gitweb.txt Gitweb Instruction Updates 2012-08-01 16:55:37 -04:00
config-headerfooter.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
config-hooks.txt Send event to stream and execute hook when merge fails 2012-10-17 17:34:14 +09:00
config-mail.txt Add email footer token to identify if inline comments are present 2012-10-18 11:50:04 +09:00
config-reverseproxy.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
config-sso.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
dev-contributing.txt Documentation: Various typo corrections 2012-05-09 13:21:35 -04:00
dev-design.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
dev-eclipse.txt Update the Maven plugin installation instructions 2012-10-30 18:19:42 +09:00
dev-plugins.txt Allow plugins to contribute InitStep to Gerrit init. 2012-10-22 10:07:31 -07:00
dev-readme.txt Update top level SUBMITTING_PATCHES 2012-02-13 23:34:50 -08:00
dev-release-deploy-config.txt Improve release documentation 2012-09-03 14:11:12 +02:00
dev-release-subproject.txt Improve release documentation 2012-09-03 14:11:12 +02:00
dev-release.txt Improve release documentation 2012-09-03 14:11:12 +02:00
error-branch-not-found.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-change-closed.txt Add documentation of "change closed" error when using ssh review 2012-06-27 10:10:23 +02:00
error-change-does-not-belong-to-project.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-change-not-found.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-change-upload-blocked.txt Added explanation for "One or more refs/for/ ..." error 2011-02-03 08:53:46 +01:00
error-contains-banned-commit.txt Added explanation for "contains banned commit" error 2011-04-08 11:00:40 +02:00
error-has-duplicates.txt Added explanation for "... has duplicates" error 2011-03-10 13:17:36 +01:00
error-invalid-author.txt Correct documentation of "invalid author/committer" errors 2012-06-26 09:24:47 +02:00
error-invalid-changeid-line.txt Clarify error messages related to commit message footer content 2012-11-13 12:18:16 +09:00
error-invalid-committer.txt Correct documentation of "invalid author/committer" errors 2012-06-26 09:24:47 +02:00
error-messages.txt Extension for commit validation plugins 2012-11-14 16:08:51 -08:00
error-missing-changeid.txt Clarify error messages related to commit message footer content 2012-11-13 12:18:16 +09:00
error-multiple-changeid-lines.txt Clarify error messages related to commit message footer content 2012-11-13 12:18:16 +09:00
error-no-changes-made.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-no-common-ancestry.txt Added explanation for "no common ancestry" error 2011-01-25 15:33:40 +01:00
error-no-new-changes.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-non-fast-forward.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-not-a-gerrit-administrator.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-not-a-gerrit-project.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-not-allowed-to-upload-merges.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-not-permitted-to-create.txt Added explanation for "Not permitted to create" error 2011-02-04 10:22:50 +01:00
error-not-signed-off-by.txt Clarify error messages related to commit message footer content 2012-11-13 12:18:16 +09:00
error-not-valid-ref.txt Added explanation for "not valid ref" error 2011-01-12 07:12:36 -08:00
error-permission-denied.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-prohibited-by-gerrit-rejected-by-plugin.txt Extension for commit validation plugins 2012-11-14 16:08:51 -08:00
error-prohibited-by-gerrit.txt Fix message if pushing tag is rejected because tagger is somebody else 2012-09-17 08:59:10 +02:00
error-push-fails-due-to-commit-message.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-squash-commits-first.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-upload-denied.txt Access control documentation: Read and Submit 2012-01-23 16:46:57 +01:00
GEN-DOC-VERSION documentation: Fix version number to only consider x.y.z format 2010-02-22 14:14:53 -08:00
i18n-readme.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
index.txt Write a Cookbook for Prolog submit rules 2012-09-17 09:13:11 +02:00
install-j2ee.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
install-quick.txt install-quick.txt: Add some clarifications to help new users 2012-06-18 10:25:34 +02:00
install.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
intro-quick.txt Minor documentation formatting and white space errors fixed 2012-10-21 16:27:18 -07:00
json.txt When a file is renamed, include old file name in Patch attribute 2012-10-31 10:42:44 +09:00
licenses.txt Minor documentation formatting and white space errors fixed 2012-10-21 16:27:18 -07:00
Makefile Make sure asciidoc uses unix line endings in generated HTML. 2012-06-27 10:19:13 +02:00
pgm-daemon.txt Fix spelling mistakes in Gerrit documentation 2011-10-27 02:24:06 +02:00
pgm-ExportReviewNotes.txt Documentation: Add documentation of refs/notes/review 2012-07-30 14:07:36 +02:00
pgm-gsql.txt Minor documentation formatting and white space errors fixed 2012-10-21 16:27:18 -07:00
pgm-index.txt Enable case insensitive login to Gerrit WebUI for LDAP authentication 2011-10-26 23:01:57 +02:00
pgm-init.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
pgm-LocalUsernamesToLowerCase.txt Enable case insensitive login to Gerrit WebUI for LDAP authentication 2011-10-26 23:01:57 +02:00
pgm-prolog-shell.txt prolog-shell: Simple command line Prolog interpreter 2011-06-21 14:15:53 -07:00
pgm-rulec.txt Fix spelling mistakes in Gerrit documentation 2011-10-27 02:24:06 +02:00
pgm-ScanTrackingIds.txt Fix spelling mistakes in Gerrit documentation 2011-10-27 02:24:06 +02:00
project-setup.txt Add submit strategy that rebases the change if necessary 2012-10-21 11:31:02 -07:00
prolog-change-facts.txt Expose basic commit statistics for the prolog rule engine. 2012-10-23 10:32:25 -04:00
prolog-cookbook.txt Documentation: Add prolog submit-rule example Submit by Author 2012-10-30 09:15:59 -04:00
refs-notes-review.txt Documentation: Add documentation of refs/notes/review 2012-07-30 14:07:36 +02:00
rest-api.txt Implement new /changes/{id}/action style REST API 2012-11-16 12:00:24 -08:00
user-changeid.txt Document execute permission for commit-msg in Change-Id docs 2012-10-03 19:16:05 -04:00
user-custom-dashboards.txt Implement ${project} tokens for dashboards queries. 2012-11-16 08:55:24 +01:00
user-notify.txt Support project notification using To or CC 2012-10-26 10:05:37 -07:00
user-search.txt Minor documentation formatting and white space errors fixed 2012-10-21 16:27:18 -07:00
user-signedoffby.txt documentation: Clean up references to 'Gerrit2' 2009-12-11 17:43:39 -08:00
user-submodules.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
user-upload.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00