gerrit/Documentation
Edwin Kempin b8590bd990 Add REST endpoint to get info about server configuration
Some of the Gerrit configuration parameters can now be accessed by

  GET /config/server/info

This REST endpoint can also be used anonymously.

For now the REST endpoint returns only a very limited set of
configuration parameters, which are needed by the Gerrit Mylyn
Connector. The result contains information about:

- auth type, editable account fields, if contributor agreements are
  used
- contact store
- download schemes, commands and archive formats
- All-Projects and All-Users project names

At the moment the Mylyn Gerrit Connector retrieves this information by
parsing the config from the HostPageData which is sent to the client.
This is an internal data structure which is used to exchange
information between Gerrit server and Gerrit WebUI. It's not an API
and third-party tools should not rely on it. As a result the Mylyn
Gerrit Connector is currently broken for Gerrit 2.11 and newer.

Provide the Mylyn Gerrit Connector team a stable API that provides
them the information they need so that future breakages can be
avoided. See Eclipse Bugzilla issue 465132 [1] for further details.

The structure of the returned JSON correlates to the structure in the
gerrit.config file.

[1] https://bugs.eclipse.org/bugs/show_bug.cgi?id=465132

Change-Id: Iac4be762bff971403438aa84923d9f0e11883366
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
2015-05-04 15:52:56 +02:00
..
images Remove documentation of "Edit Message" feature 2015-01-30 05:32:46 +00:00
access-control.txt Document that submit should for granted on refs/heads/* 2015-04-16 15:13:44 +02:00
asciidoc.defs Add buck rule to generate docs for static hosting. 2014-09-05 14:19:15 -07:00
BUCK Add buck rule to generate docs for static hosting. 2014-09-05 14:19:15 -07:00
cmd-apropos.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-ban-commit.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-cherry-pick.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-close-connection.txt Add command to close SSH connection 2015-01-19 09:54:55 -05:00
cmd-create-account.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-create-branch.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-create-group.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-create-project.txt Tidy up documentation of --create-new-change-for-all-not-in-target 2014-12-03 21:58:23 +09:00
cmd-flush-caches.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-gc.txt Add "aggressive" option to ssh command "GC" 2015-03-19 15:45:29 +01:00
cmd-gsql.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-hook-commit-msg.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-index.txt Add set-head SSH command 2015-03-05 09:12:55 +01:00
cmd-kill.txt Revert "== GERRIT" in documentation. 2014-03-25 19:44:49 +00:00
cmd-logging-ls-level.txt Add SSH to configure logging level at runtime 2014-09-26 09:13:35 -04:00
cmd-logging-set-level.txt Add SSH to configure logging level at runtime 2014-09-26 09:13:35 -04:00
cmd-ls-groups.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-ls-members.txt Documentation: Format fix headlines 2014-03-24 18:32:42 -07:00
cmd-ls-projects.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-ls-user-refs.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-plugin-enable.txt Documentation update for cmd-plugin 2015-01-21 11:03:08 +09:00
cmd-plugin-install.txt Documentation update for cmd-plugin 2015-01-21 11:03:08 +09:00
cmd-plugin-ls.txt Correct documentation of required capabilities for listing plugins 2015-04-30 00:58:28 +00:00
cmd-plugin-reload.txt Documentation update for cmd-plugin 2015-01-21 11:03:08 +09:00
cmd-plugin-remove.txt Documentation update for cmd-plugin 2015-01-21 11:03:08 +09:00
cmd-query.txt Terminate sortkey with prejudice 2014-12-23 14:48:06 -08:00
cmd-receive-pack.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-rename-group.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-review.txt Add --rebase option to review command 2014-09-09 13:08:04 -04:00
cmd-set-account.txt Close security hole allowing normal user to become admin 2014-10-03 09:53:34 +00:00
cmd-set-head.txt Update set-head ssh command documentation 2015-03-05 09:50:10 +01:00
cmd-set-members.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-set-project-parent.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-set-project.txt Fix inconsistency in documentation 2014-05-07 14:51:17 +02:00
cmd-set-reviewers.txt Consistently refer to Change-Id in documentation 2014-09-04 13:12:24 +09:00
cmd-show-caches.txt Merge "Require 'Administrate Server' capability to see server summary" 2014-07-02 18:57:01 +00:00
cmd-show-connections.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-show-queue.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-stream-events.txt Add the ability to run a new project created hook 2015-04-21 14:53:53 +09:00
cmd-suexec.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-test-submit-rule.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-test-submit-type.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
cmd-version.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
config-auto-site-initialization.txt Control which plugins will be auto installed on auto init 2014-02-24 11:11:04 +01:00
config-cla.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
config-contact.txt OpenID: Remove support for Google Accounts 2015-03-01 22:25:50 +01:00
config-gerrit.txt IndexConfig: Add maxPages option 2015-04-23 11:31:41 -07:00
config-gitweb.txt Work around asciidoctor handling of nested ` and * 2015-04-06 17:22:37 +09:00
config-hooks.txt Merge branch 'stable-2.11' 2015-04-27 18:25:04 +09:00
config-labels.txt Fix formatting in documentation about review labels 2015-04-07 09:38:36 +02:00
config-login-register.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
config-mail.txt Documentation: Case consistencies for SEE ALSO 2014-03-24 19:02:08 -07:00
config-plugins.txt Merge branch 'stable-2.11' 2015-04-20 10:32:27 +09:00
config-project-config.txt Work around asciidoctor handling of nested ` and * 2015-04-06 17:22:37 +09:00
config-reverseproxy.txt Mention access control change in Apache 2.4 2015-04-27 10:43:51 -07:00
config-sso.txt OpenID: Remove support for Google Accounts 2015-03-01 22:25:50 +01:00
config-themes.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
config-validation.txt Added OutgoingEmailValidationListener 2015-01-06 09:02:39 +01:00
config.defs Bump asciidoctorj to 1.5.0. 2014-08-22 10:32:51 -07:00
database-setup.txt Merge branch 'stable-2.8' into stable-2.9 2014-07-08 18:24:26 +09:00
dev-buck.txt Merge "Merge branch 'stable-2.11'" 2015-04-20 07:23:55 +00:00
dev-build-plugins.txt Add HOWTO documentation about building of plugins 2014-01-24 23:16:25 +01:00
dev-contributing.txt Document one argument per line for constructor injection 2015-02-10 09:58:47 +01:00
dev-design.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
dev-eclipse.txt Tidy up the Eclipse debugging documentation 2015-01-16 19:26:25 +09:00
dev-inspector.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
dev-plugins.txt Merge branch 'stable-2.11' 2015-04-07 10:52:27 +09:00
dev-readme.txt Add doc for directories to likely mark so that IDEA project can compile 2015-03-17 01:50:46 +00:00
dev-release-deploy-config.txt dev-release-deploy-config: Update Maven config for Google Storage 2015-04-17 14:06:49 +09:00
dev-release-subproject.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
dev-release.txt dev-release{-deploy-config}.txt: Fix links to Google Developers console 2015-04-17 14:01:59 +09:00
dev-rest-api.txt Make Content-Type examples consistent with actual server output 2015-01-06 06:54:12 +00:00
doc.css.in Fix rendering of links in license documentation 2014-11-04 22:55:01 +01:00
error-branch-not-found.txt Doc: Consistently refer to "Web UI" rather than "WebUI" 2014-05-02 17:21:22 +09:00
error-change-closed.txt Doc: Consistently refer to "Web UI" rather than "WebUI" 2014-05-02 17:21:22 +09:00
error-change-does-not-belong-to-project.txt Consistently refer to Change-Id in documentation 2014-09-04 13:12:24 +09:00
error-change-not-found.txt Consistently refer to Change-Id in documentation 2014-09-04 13:12:24 +09:00
error-change-upload-blocked.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
error-commit-already-exists.txt Merge branch 'stable-2.8' 2014-03-11 18:24:13 +09:00
error-contains-banned-commit.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
error-has-duplicates.txt Consistently refer to Change-Id in documentation 2014-09-04 13:12:24 +09:00
error-invalid-author.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
error-invalid-changeid-line.txt Doc: Consistently refer to "Web UI" rather than "WebUI" 2014-05-02 17:21:22 +09:00
error-invalid-committer.txt Fix reference to Forge Committer access right in documentation 2014-07-08 07:24:01 +00:00
error-messages.txt Improve reject message if Change-Id is in subject 2014-02-21 09:25:33 +01:00
error-missing-changeid.txt Consistently refer to Change-Id in documentation 2014-09-04 13:12:24 +09:00
error-missing-subject.txt Improve reject message if Change-Id is in subject 2014-02-21 09:25:33 +01:00
error-multiple-changeid-lines.txt Doc: Consistently refer to "Web UI" rather than "WebUI" 2014-05-02 17:21:22 +09:00
error-no-changes-made.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
error-no-common-ancestry.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
error-no-new-changes.txt Doc: Consistently refer to "Web UI" rather than "WebUI" 2014-05-02 17:21:22 +09:00
error-non-fast-forward.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
error-not-a-gerrit-administrator.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
error-not-allowed-to-upload-merges.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
error-not-permitted-to-create.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
error-not-signed-off-by.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
error-not-valid-ref.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
error-permission-denied.txt Doc: Consistently refer to "Web UI" rather than "WebUI" 2014-05-02 17:21:22 +09:00
error-prohibited-by-gerrit.txt Work around asciidoctor handling of nested ` and * 2015-04-06 17:22:37 +09:00
error-project-not-found.txt Doc: Consistently refer to "Web UI" rather than "WebUI" 2014-05-02 17:21:22 +09:00
error-push-fails-due-to-commit-message.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
error-squash-commits-first.txt Minor improvements in the 'squash commits first' error documentation 2014-09-05 09:25:33 +09:00
error-upload-denied.txt Added searchbox to documentation. 2013-11-05 12:49:43 -08:00
gen_licenses.py Fix rendering of links in license documentation 2014-11-04 22:55:01 +01:00
i18n-readme.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
index.txt Add documentation about plugins 2015-02-15 12:40:41 +00:00
install-j2ee.txt Fix broken formatting in Tomcat reverse proxy config documentation 2014-10-21 11:04:42 +09:00
install-quick.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
install.txt Fix inconsistency in documentation 2014-05-07 14:51:17 +02:00
intro-project-owner.txt Merge branch 'stable-2.11' 2015-04-20 10:32:27 +09:00
intro-quick.txt Consistently refer to Change-Id in documentation 2014-09-04 13:12:24 +09:00
js-api.txt Allow plugins to check if user is signed in 2015-01-20 23:16:26 +01:00
json.txt Added copyAllScoresIfNoChange 2015-02-17 10:29:38 +09:00
pgm-daemon.txt Allow to use --enable-httpd with --slave 2014-10-30 11:02:24 -04:00
pgm-gsql.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
pgm-index.txt Add documentation for SecureStore 2015-02-23 09:53:05 +01:00
pgm-init.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
pgm-LocalUsernamesToLowerCase.txt Doc: Consistently refer to "Web UI" rather than "WebUI" 2014-05-02 17:21:22 +09:00
pgm-prolog-shell.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
pgm-reindex.txt Document the --recheck-mergeable flag for the reindex program 2014-01-22 19:22:03 +09:00
pgm-rulec.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
pgm-SwitchSecureStore.txt Add documentation for SecureStore 2015-02-23 09:53:05 +01:00
project-configuration.txt Improve the textual description of the content merge option 2015-04-16 18:44:19 +00:00
prolog-change-facts.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
prolog-cookbook.txt Work around asciidoctor handling of nested ` and * 2015-04-06 17:22:37 +09:00
replace_macros.py Merge branch 'stable-2.10' 2014-12-12 20:25:48 +09:00
rest-api-access.txt Make Content-Type examples consistent with actual server output 2015-01-06 06:54:12 +00:00
rest-api-accounts.txt ChangeScreen: Allow to disable muting of common paths in file table 2015-02-02 11:17:45 +01:00
rest-api-changes.txt Revert marking merged or abandoned changes in related changes 2015-04-09 13:00:45 +00:00
rest-api-config.txt Add REST endpoint to get info about server configuration 2015-05-04 15:52:56 +02:00
rest-api-documentation.txt Don't limit tables to 50% width in REST API documentation 2014-11-25 18:35:53 +09:00
rest-api-groups.txt Sort REST JSON entities alphabetically 2015-01-26 04:45:30 +00:00
rest-api-plugins.txt Make Content-Type examples consistent with actual server output 2015-01-06 06:54:12 +00:00
rest-api-projects.txt Add "aggressive" option to REST call "Run GC" 2015-03-19 15:43:49 +01:00
rest-api.txt Consistently format HTTP response codes in REST API documentation 2015-01-21 11:42:32 +09:00
user-changeid.txt Work around asciidoctor handling of nested ` and * 2015-04-06 17:22:37 +09:00
user-dashboards.txt Work around asciidoctor handling of nested ` and * 2015-04-06 17:22:37 +09:00
user-inline-edit.txt InlineEdit: Clarify difference between remove and revert operation 2015-04-16 07:20:17 +00:00
user-notify.txt Clarify notification scheme on watched projects 2014-12-12 13:46:38 -06:00
user-review-ui.txt Revert marking merged or abandoned changes in related changes 2015-04-09 13:00:45 +00:00
user-search.txt Add "from" search operator to match by owner or comments 2015-03-17 14:44:48 -07:00
user-signedoffby.txt Revert "== GERRIT" in documentation. 2014-03-25 19:44:49 +00:00
user-submodules.txt Use the new section title style in Asciidoctor. 2013-12-20 12:55:51 -08:00
user-upload.txt Work around asciidoctor handling of nested ` and * 2015-04-06 17:22:37 +09:00