opendev/gerrit
Code Issues Proposed changes

Bypass the rendering differences in AsciiDoctor.

Browse Source 
AsciiDoctor have different understanding of [verse] with asciidoc, causing some
rendering differences. To get similar result with asciidoc, we use something
else instead of [verse] now.

Screenshots:
before:
http://imgur.com/JKMdBiv
after:
http://imgur.com/yFVvVac

Change-Id: I14e84f0e998e1e87b633681e8028ad657bde07e4
This commit is contained in:
Yuxuan 'fishy' Wang 2013-11-15 11:47:46 -08:00
parent 4e8a96f708
commit d85b687536
54 changed files with 370 additions and 185 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Documentation/access-control.txt
View File

@ -335,10 +335,11 @@ reference in their git. The format is convenient but still intended to scale to
hundreds of thousands of patch sets. To access a given patch set you will hundreds of thousands of patch sets. To access a given patch set you will
need the change number and patch set number. need the change number and patch set number.
[verse] --
'refs/changes/'<last two digits of change number>/ 'refs/changes/'<last two digits of change number>/
<change number>/ <change number>/
<patch set number> <patch set number>
--
You can also find these static references linked on the page of each change. You can also find these static references linked on the page of each change.

3
Documentation/cmd-apropos.txt
View File

@ -7,9 +7,10 @@ gerrit apropos - Search Gerrit documentation index
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit apropos' 'ssh' -p <port> <host> 'gerrit apropos'
<query> <query>
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-ban-commit.txt
View File

@ -7,11 +7,12 @@ gerrit ban-commit - Bans a commit from a project's repository.
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit ban-commit' 'ssh' -p <port> <host> 'gerrit ban-commit'
[--reason <REASON>] [--reason <REASON>]
<PROJECT> <PROJECT>
<COMMIT> ... <COMMIT> ...
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-cherry-pick.txt
View File

@ -7,10 +7,11 @@ gerrit-cherry-pick - Download and cherry pick one or more changes
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'gerrit-cherry-pick' <remote> <changeid>... 'gerrit-cherry-pick' <remote> <changeid>...
'gerrit-cherry-pick' --continue | --skip | --abort 'gerrit-cherry-pick' --continue | --skip | --abort
'gerrit-cherry-pick' --close <remote> 'gerrit-cherry-pick' --close <remote>
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-create-account.txt
View File

@ -7,7 +7,7 @@ gerrit create-account - Create a new user account.
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit create-account' 'ssh' -p <port> <host> 'gerrit create-account'
[--group <GROUP>] [--group <GROUP>]
[--full-name <FULLNAME>] [--full-name <FULLNAME>]
@ -15,6 +15,7 @@ SYNOPSIS
[--ssh-key - | <KEY>] [--ssh-key - | <KEY>]
[--http-password <PASSWORD>] [--http-password <PASSWORD>]
<USERNAME> <USERNAME>
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-create-group.txt
View File

@ -7,7 +7,7 @@ gerrit create-group - Create a new account group.
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit create-group' 'ssh' -p <port> <host> 'gerrit create-group'
[--owner <GROUP> | -o <GROUP>] [--owner <GROUP> | -o <GROUP>]
[--description <DESC> | -d <DESC>] [--description <DESC> | -d <DESC>]
@ -15,6 +15,7 @@ SYNOPSIS
[--group <GROUP>] [--group <GROUP>]
[--visible-to-all] [--visible-to-all]
<GROUP> <GROUP>
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-create-project.txt
View File

@ -7,7 +7,7 @@ gerrit create-project - Create a new hosted project
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit create-project' 'ssh' -p <port> <host> 'gerrit create-project'
[--owner <GROUP> ... | -o <GROUP> ...] [--owner <GROUP> ... | -o <GROUP> ...]
[--parent <NAME> | -p <NAME> ] [--parent <NAME> | -p <NAME> ]
@ -23,6 +23,7 @@ SYNOPSIS
[--empty-commit] [--empty-commit]
[--max-object-size-limit <N>] [--max-object-size-limit <N>]
{ <NAME> | --name <NAME> } { <NAME> | --name <NAME> }
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-flush-caches.txt
View File

@ -7,10 +7,11 @@ gerrit flush-caches - Flush some/all server caches from memory
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit flush-caches' --all 'ssh' -p <port> <host> 'gerrit flush-caches' --all
'ssh' -p <port> <host> 'gerrit flush-caches' --list 'ssh' -p <port> <host> 'gerrit flush-caches' --list
'ssh' -p <port> <host> 'gerrit flush-caches' --cache <NAME> ... 'ssh' -p <port> <host> 'gerrit flush-caches' --cache <NAME> ...
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-gc.txt
View File

@ -7,11 +7,12 @@ gerrit gc - Run the Git garbage collection
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit gc' 'ssh' -p <port> <host> 'gerrit gc'
[--all] [--all]
[--show-progress] [--show-progress]
<NAME> ... <NAME> ...
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-gsql.txt
View File

@ -7,10 +7,11 @@ gerrit gsql - Administrative interface to active database
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit gsql' 'ssh' -p <port> <host> 'gerrit gsql'
[--format {PRETTY | JSON | JSON_SINGLE}] [--format {PRETTY | JSON | JSON_SINGLE}]
[-c QUERY] [-c QUERY]
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-kill.txt
View File

@ -7,8 +7,9 @@ kill - Cancel or abort a background task
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'kill' <ID> ... 'ssh' -p <port> <host> 'kill' <ID> ...
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-ls-groups.txt
View File

@ -7,7 +7,7 @@ gerrit ls-groups - List groups visible to caller
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit ls-groups' 'ssh' -p <port> <host> 'gerrit ls-groups'
[--project <NAME> | -p <NAME>] [--project <NAME> | -p <NAME>]
[--user <NAME> | -u <NAME>] [--user <NAME> | -u <NAME>]
@ -16,6 +16,7 @@ SYNOPSIS
[--type {internal | system}] [--type {internal | system}]
[-q <GROUP>] [-q <GROUP>]
[--verbose | -v] [--verbose | -v]
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-ls-members.txt
View File

@ -7,9 +7,10 @@ gerrit ls-members - Show members of a given group
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit ls-members GROUPNAME' 'ssh' -p <port> <host> 'gerrit ls-members GROUPNAME'
[--recursive] [--recursive]
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-ls-projects.txt
View File

@ -7,7 +7,7 @@ gerrit ls-projects - List projects visible to caller
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit ls-projects' 'ssh' -p <port> <host> 'gerrit ls-projects'
[--show-branch <BRANCH> ...] [--show-branch <BRANCH> ...]
[--description | -d] [--description | -d]
@ -17,6 +17,7 @@ SYNOPSIS
[--all] [--all]
[--limit <N>] [--limit <N>]
[--has-acl-for GROUP] [--has-acl-for GROUP]
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-ls-user-refs.txt
View File

@ -7,11 +7,12 @@ gerrit ls-user-refs - List refs visible to a specific user
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit ls-user-refs' 'ssh' -p <port> <host> 'gerrit ls-user-refs'
[--project PROJECT> | -p <PROJECT>] [--project PROJECT> | -p <PROJECT>]
[--user <USER> | -u <USER>] [--user <USER> | -u <USER>]
[--only-refs-heads] [--only-refs-heads]
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-plugin-enable.txt
View File

@ -7,9 +7,10 @@ plugin enable - Enable plugins.
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit plugin enable' 'ssh' -p <port> <host> 'gerrit plugin enable'
<NAME> ... <NAME> ...
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-plugin-install.txt
View File

@ -9,10 +9,11 @@ plugin add - Install/Add a plugin.
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit plugin install | add' 'ssh' -p <port> <host> 'gerrit plugin install | add'
[--name <NAME> | -n <NAME>] [--name <NAME> | -n <NAME>]
- | <URL> | <PATH> - | <URL> | <PATH>
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-plugin-ls.txt
View File

@ -7,10 +7,11 @@ plugin ls - List the installed plugins.
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit plugin ls' 'ssh' -p <port> <host> 'gerrit plugin ls'
[--all | -a] [--all | -a]
[--format {text | json | json_compact}] [--format {text | json | json_compact}]
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-plugin-reload.txt
View File

@ -7,9 +7,10 @@ plugin reload - Reload/Restart plugins.
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit plugin reload' 'ssh' -p <port> <host> 'gerrit plugin reload'
<NAME> ... <NAME> ...
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-plugin-remove.txt
View File

@ -9,9 +9,10 @@ plugin rm - Disable plugins.
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit plugin remove | rm' 'ssh' -p <port> <host> 'gerrit plugin remove | rm'
<NAME> ... <NAME> ...
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-query.txt
View File

@ -7,7 +7,7 @@ gerrit query - Query the change database
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit query' 'ssh' -p <port> <host> 'gerrit query'
[--format {TEXT | JSON}] [--format {TEXT | JSON}]
[--current-patch-set] [--current-patch-set]
@ -22,6 +22,7 @@ SYNOPSIS
<query> <query>
[limit:<n>] [limit:<n>]
[resume_sortkey:<sortKey>] [resume_sortkey:<sortKey>]
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-receive-pack.txt
View File

@ -7,11 +7,12 @@ git-receive-pack - Receive what is pushed into the repository
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'git receive-pack' 'git receive-pack'
[--reviewer <address> | --re <address>] [--reviewer <address> | --re <address>]
[--cc <address>] [--cc <address>]
<project> <project>
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-rename-group.txt
View File

@ -7,10 +7,11 @@ gerrit rename-group - Rename an account group.
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit rename-group' 'ssh' -p <port> <host> 'gerrit rename-group'
<GROUP> <GROUP>
<NEWNAME> <NEWNAME>
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-review.txt
View File

@ -7,7 +7,7 @@ gerrit review - Verify, approve and/or submit one or more patch sets
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit review' 'ssh' -p <port> <host> 'gerrit review'
[--project <PROJECT> | -p <PROJECT>] [--project <PROJECT> | -p <PROJECT>]
[--message <MESSAGE> | -m <MESSAGE>] [--message <MESSAGE> | -m <MESSAGE>]
@ -18,6 +18,7 @@ SYNOPSIS
[--verified <N>] [--code-review <N>] [--verified <N>] [--code-review <N>]
[--label Label-Name=<N>] [--label Label-Name=<N>]
{COMMIT | CHANGEID,PATCHSET}... {COMMIT | CHANGEID,PATCHSET}...
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-set-account.txt
View File

@ -7,12 +7,13 @@ gerrit set-account - Change an account's settings.
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
set-account [--full-name <FULLNAME>] [--active|--inactive] \ set-account [--full-name <FULLNAME>] [--active|--inactive] \
[--add-email <EMAIL>] [--delete-email <EMAIL> | ALL] \ [--add-email <EMAIL>] [--delete-email <EMAIL> | ALL] \
[--add-ssh-key - | <KEY>] \ [--add-ssh-key - | <KEY>] \
[--delete-ssh-key - | <KEY> | ALL] \ [--delete-ssh-key - | <KEY> | ALL] \
[--http-password <PASSWORD>] <USER> [--http-password <PASSWORD>] <USER>
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-set-members.txt
View File

@ -7,7 +7,7 @@ gerrit set-members - Set group members
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit set-members' 'ssh' -p <port> <host> 'gerrit set-members'
[--add USER ...] [--add USER ...]
[--remove USER ...] [--remove USER ...]
@ -15,6 +15,7 @@ SYNOPSIS
[--exclude GROUP ...] [--exclude GROUP ...]
[--] [--]
<GROUP> ... <GROUP> ...
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-set-project-parent.txt
View File

@ -7,12 +7,13 @@ gerrit set-project-parent - Change the project permissions are inherited from.
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit set-project-parent' 'ssh' -p <port> <host> 'gerrit set-project-parent'
[--parent <NAME>] [--parent <NAME>]
[--children-of <NAME>] [--children-of <NAME>]
[--exclude <NAME>] [--exclude <NAME>]
<NAME> ... <NAME> ...
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-set-project.txt
View File

@ -7,7 +7,7 @@ gerrit set-project - Change a project's settings.
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit set-project' 'ssh' -p <port> <host> 'gerrit set-project'
[--description <DESC> | -d <DESC>] [--description <DESC> | -d <DESC>]
[--submit-type <TYPE> | -t <TYPE>] [--submit-type <TYPE> | -t <TYPE>]
@ -18,6 +18,7 @@ SYNOPSIS
[--project-state <STATE> | --ps <STATE>] [--project-state <STATE> | --ps <STATE>]
[--max-object-size-limit <N>] [--max-object-size-limit <N>]
<NAME> <NAME>
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-set-reviewers.txt
View File

@ -7,13 +7,14 @@ gerrit set-reviewers - Add or remove reviewers to a change
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit set-reviewers' 'ssh' -p <port> <host> 'gerrit set-reviewers'
[--project <PROJECT> | -p <PROJECT>] [--project <PROJECT> | -p <PROJECT>]
[--add <REVIEWER> ... | -a <REVIEWER> ...] [--add <REVIEWER> ... | -a <REVIEWER> ...]
[--remove <REVIEWER> ... | -r <REVIEWER> ...] [--remove <REVIEWER> ... | -r <REVIEWER> ...]
[--] [--]
{COMMIT | CHANGE-ID}... {COMMIT | CHANGE-ID}...
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-show-caches.txt
View File

@ -7,8 +7,9 @@ gerrit show-caches - Display current cache statistics
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit show-caches' [--gc] [--show-jvm] 'ssh' -p <port> <host> 'gerrit show-caches' [--gc] [--show-jvm]
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-show-connections.txt
View File

@ -7,8 +7,9 @@ gerrit show-connections - Display active client SSH connections
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit show-connections' [--numeric | -n] 'ssh' -p <port> <host> 'gerrit show-connections' [--numeric | -n]
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-show-queue.txt
View File

@ -7,9 +7,10 @@ gerrit show-queue - Display the background work queues, including replication
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit show-queue' 'ssh' -p <port> <host> 'gerrit show-queue'
'ssh' -p <port> <host> 'ps' 'ssh' -p <port> <host> 'ps'
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-stream-events.txt
View File

@ -7,8 +7,9 @@ gerrit stream-events - Monitor events occurring in real time
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit stream-events' 'ssh' -p <port> <host> 'gerrit stream-events'
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-suexec.txt
View File

@ -7,7 +7,7 @@ suexec - Execute a command as any registered user account
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> 'ssh' -p <port>
-i SITE_PATH/etc/ssh_host_rsa_key -i SITE_PATH/etc/ssh_host_rsa_key
'"Gerrit Code Review@localhost"' '"Gerrit Code Review@localhost"'
@ -16,6 +16,7 @@ SYNOPSIS
[--from HOST:PORT] [--from HOST:PORT]
[--] [--]
[COMMAND] [COMMAND]
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-test-submit-rule.txt
View File

@ -7,11 +7,12 @@ gerrit test-submit rule - Test prolog submit rules with a chosen changeset.
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit test-submit rule' 'ssh' -p <port> <host> 'gerrit test-submit rule'
[-s] [-s]
[--no-filters] [--no-filters]
CHANGE CHANGE
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-test-submit-type.txt
View File

@ -7,11 +7,12 @@ gerrit test-submit type - Test prolog submit type with a chosen change.
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit test-submit type' 'ssh' -p <port> <host> 'gerrit test-submit type'
[-s] [-s]
[--no-filters] [--no-filters]
CHANGE CHANGE
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/cmd-version.txt
View File

@ -7,8 +7,9 @@ gerrit version - Show the version of the currently executing Gerrit server
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'ssh' -p <port> <host> 'gerrit version' 'ssh' -p <port> <host> 'gerrit version'
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/dev-inspector.txt
View File

@ -7,7 +7,7 @@ Gerrit Inspector - Interactive Jython environment for Gerrit
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'java' -jar gerrit.war 'daemon' 'java' -jar gerrit.war 'daemon'
-d <SITE_PATH> -d <SITE_PATH>
[\--enable-httpd | \--disable-httpd] [\--enable-httpd | \--disable-httpd]
@ -15,6 +15,7 @@ SYNOPSIS
[\--console-log] [\--console-log]
[\--slave] [\--slave]
-s -s
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/pgm-LocalUsernamesToLowerCase.txt
View File

@ -8,8 +8,9 @@ account to lower case
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'java' -jar gerrit.war 'LocalUsernamesToLowerCase' -d <SITE_PATH> 'java' -jar gerrit.war 'LocalUsernamesToLowerCase' -d <SITE_PATH>
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/pgm-ScanTrackingIds.txt
View File

@ -7,8 +7,9 @@ ScanTrackingIds - Rescan changes to index trackingids
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'java' -jar gerrit.war 'ScanTrackingIds' -d <SITE_PATH> 'java' -jar gerrit.war 'ScanTrackingIds' -d <SITE_PATH>
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/pgm-daemon.txt
View File

@ -7,7 +7,7 @@ daemon - Gerrit network server
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'java' -jar gerrit.war 'daemon' 'java' -jar gerrit.war 'daemon'
-d <SITE_PATH> -d <SITE_PATH>
[\--enable-httpd | \--disable-httpd] [\--enable-httpd | \--disable-httpd]
@ -17,6 +17,7 @@ SYNOPSIS
[\--headless] [\--headless]
[\--init] [\--init]
[-s] [-s]
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/pgm-gsql.txt
View File

@ -7,8 +7,9 @@ gsql - Administrative interface to idle database
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'java' -jar gerrit.war 'gsql' -d <SITE_PATH> 'java' -jar gerrit.war 'gsql' -d <SITE_PATH>
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/pgm-init.txt
View File

@ -7,13 +7,14 @@ init - Initialize a new Gerrit server installation
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'java' -jar gerrit.war 'init' 'java' -jar gerrit.war 'init'
-d <SITE_PATH> -d <SITE_PATH>
[\--batch] [\--batch]
[\--no-auto-start] [\--no-auto-start]
[\--list-plugins] [\--list-plugins]
[\--install-plugin=<PLUGIN_NAME>] [\--install-plugin=<PLUGIN_NAME>]
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/pgm-prolog-shell.txt
View File

@ -7,8 +7,9 @@ prolog-shell - Simple interactive Prolog interpreter
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'java' -jar gerrit.war 'prolog-shell' [-s FILE.pl ...] 'java' -jar gerrit.war 'prolog-shell' [-s FILE.pl ...]
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/pgm-reindex.txt
View File

@ -7,8 +7,9 @@ reindex - Rebuild the secondary index
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'java' -jar gerrit.war 'reindex' [<OPTIONS>] 'java' -jar gerrit.war 'reindex' [<OPTIONS>]
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/pgm-rulec.txt
View File

@ -7,8 +7,9 @@ rulec - Compile project-specific Prolog rules to JARs
SYNOPSIS SYNOPSIS
-------- --------
[verse] --
'java' -jar gerrit.war 'rulec' -d <SITE_PATH> [--all | <PROJECT>...] 'java' -jar gerrit.war 'rulec' -d <SITE_PATH> [--all | <PROJECT>...]
--
DESCRIPTION DESCRIPTION
----------- -----------

3
Documentation/rest-api-access.txt
View File

@ -12,8 +12,9 @@ Access Rights Endpoints
[[list-access]] [[list-access]]
List Access Rights List Access Rights
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
[verse] --
'GET /access/?project=link:rest-api-projects.html#project-name[\{project-name\}]' 'GET /access/?project=link:rest-api-projects.html#project-name[\{project-name\}]'
--
Lists the access rights for projects. The projects for which the access Lists the access rights for projects. The projects for which the access
rights should be returned must be specified as `project` options. The rights should be returned must be specified as `project` options. The

93
Documentation/rest-api-accounts.txt
View File

@ -12,8 +12,9 @@ Account Endpoints
[[get-account]] [[get-account]]
Get Account Get Account
~~~~~~~~~~~ ~~~~~~~~~~~
[verse] --
'GET /accounts/link:#account-id[\{account-id\}]' 'GET /accounts/link:#account-id[\{account-id\}]'
--
Returns an account as an link:#account-info[AccountInfo] entity. Returns an account as an link:#account-info[AccountInfo] entity.
@ -40,8 +41,9 @@ Returns an account as an link:#account-info[AccountInfo] entity.
[[create-account]] [[create-account]]
Create Account Create Account
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
[verse] --
'PUT /accounts/link:#username[\{username\}]' 'PUT /accounts/link:#username[\{username\}]'
--
Creates a new account. Creates a new account.
@ -84,8 +86,9 @@ returned that describes the created account.
[[get-account-name]] [[get-account-name]]
Get Account Name Get Account Name
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
[verse] --
'GET /accounts/link:#account-id[\{account-id\}]/name' 'GET /accounts/link:#account-id[\{account-id\}]/name'
--
Retrieves the full name of an account. Retrieves the full name of an account.
@ -109,8 +112,9 @@ If the account does not have a name an empty string is returned.
[[set-account-name]] [[set-account-name]]
Set Account Name Set Account Name
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
[verse] --
'PUT /accounts/link:#account-id[\{account-id\}]/name' 'PUT /accounts/link:#account-id[\{account-id\}]/name'
--
Sets the full name of an account. Sets the full name of an account.
@ -147,8 +151,9 @@ request is rejected with "`405 Method Not Allowed`".
[[delete-account-name]] [[delete-account-name]]
Delete Account Name Delete Account Name
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
[verse] --
'DELETE /accounts/link:#account-id[\{account-id\}]/name' 'DELETE /accounts/link:#account-id[\{account-id\}]/name'
--
Deletes the name of an account. Deletes the name of an account.
@ -165,8 +170,9 @@ Deletes the name of an account.
[[get-username]] [[get-username]]
Get Username Get Username
~~~~~~~~~~~~ ~~~~~~~~~~~~
[verse] --
'GET /accounts/link:#account-id[\{account-id\}]/username' 'GET /accounts/link:#account-id[\{account-id\}]/username'
--
Retrieves the username of an account. Retrieves the username of an account.
@ -190,8 +196,9 @@ If the account does not have a username the response is `404 Not Found`.
[[get-active]] [[get-active]]
Get Active Get Active
~~~~~~~~~~ ~~~~~~~~~~
[verse] --
'GET /accounts/link:#account-id[\{account-id\}]/active' 'GET /accounts/link:#account-id[\{account-id\}]/active'
--
Checks if an account is active. Checks if an account is active.
@ -214,8 +221,9 @@ If the account is inactive the response is `204 No Content`.
[[set-active]] [[set-active]]
Set Active Set Active
~~~~~~~~~~ ~~~~~~~~~~
[verse] --
'PUT /accounts/link:#account-id[\{account-id\}]/active' 'PUT /accounts/link:#account-id[\{account-id\}]/active'
--
Sets the account state to active. Sets the account state to active.
@ -234,8 +242,9 @@ If the account was already active the response is `200 OK`.
[[delete-active]] [[delete-active]]
Delete Active Delete Active
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'DELETE /accounts/link:#account-id[\{account-id\}]/active' 'DELETE /accounts/link:#account-id[\{account-id\}]/active'
--
Sets the account state to inactive. Sets the account state to inactive.
@ -254,8 +263,9 @@ If the account was already inactive the response is `404 Not Found`.
[[get-http-password]] [[get-http-password]]
Get HTTP Password Get HTTP Password
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
[verse] --
'GET /accounts/link:#account-id[\{account-id\}]/password.http' 'GET /accounts/link:#account-id[\{account-id\}]/password.http'
--
Retrieves the HTTP password of an account. Retrieves the HTTP password of an account.
@ -279,8 +289,9 @@ If the account does not have an HTTP password the response is `404 Not Found`.
[[set-http-password]] [[set-http-password]]
Set/Generate HTTP Password Set/Generate HTTP Password
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
[verse] --
'PUT /accounts/link:#account-id[\{account-id\}]/password.http' 'PUT /accounts/link:#account-id[\{account-id\}]/password.http'
--
Sets/Generates the HTTP password of an account. Sets/Generates the HTTP password of an account.
@ -315,8 +326,9 @@ If the HTTP password was deleted the response is "`204 No Content`".
[[delete-http-password]] [[delete-http-password]]
Delete HTTP Password Delete HTTP Password
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
[verse] --
'DELETE /accounts/link:#account-id[\{account-id\}]/password.http' 'DELETE /accounts/link:#account-id[\{account-id\}]/password.http'
--
Deletes the HTTP password of an account. Deletes the HTTP password of an account.
@ -333,8 +345,9 @@ Deletes the HTTP password of an account.
[[list-account-emails]] [[list-account-emails]]
List Account Emails List Account Emails
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
[verse] --
'GET /accounts/link:#account-id[\{account-id\}]/emails' 'GET /accounts/link:#account-id[\{account-id\}]/emails'
--
Returns the email addresses that are configured for the specified user. Returns the email addresses that are configured for the specified user.
@ -367,8 +380,9 @@ link:#email-info[EmailInfo] entities.
[[get-account-email]] [[get-account-email]]
Get Account Email Get Account Email
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
[verse] --
'GET /accounts/link:#account-id[\{account-id\}]/emails/link:#email-id[\{email-id\}]' 'GET /accounts/link:#account-id[\{account-id\}]/emails/link:#email-id[\{email-id\}]'
--
Retrieves an email address of a user. Retrieves an email address of a user.
@ -396,8 +410,9 @@ describes the email address.
[[create-account-email]] [[create-account-email]]
Create Account Email Create Account Email
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
[verse] --
'PUT /accounts/link:#account-id[\{account-id\}]/emails/link:#email-id[\{email-id\}]' 'PUT /accounts/link:#account-id[\{account-id\}]/emails/link:#email-id[\{email-id\}]'
--
Registers a new email address for the user. A verification email is Registers a new email address for the user. A verification email is
sent with a link that needs to be visited to confirm the email address, sent with a link that needs to be visited to confirm the email address,
@ -434,8 +449,9 @@ link:#email-info[EmailInfo] entity.
[[delete-account-email]] [[delete-account-email]]
Delete Account Email Delete Account Email
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
[verse] --
'DELETE /accounts/link:#account-id[\{account-id\}]/emails/link:#email-id[\{email-id\}]' 'DELETE /accounts/link:#account-id[\{account-id\}]/emails/link:#email-id[\{email-id\}]'
--
Deletes an email address of an account. Deletes an email address of an account.
@ -452,8 +468,9 @@ Deletes an email address of an account.
[[set-preferred-email]] [[set-preferred-email]]
Set Preferred Email Set Preferred Email
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
[verse] --
'PUT /accounts/link:#account-id[\{account-id\}]/emails/link:#email-id[\{email-id\}]/preferred' 'PUT /accounts/link:#account-id[\{account-id\}]/emails/link:#email-id[\{email-id\}]/preferred'
--
Sets an email address as preferred email address for an account. Sets an email address as preferred email address for an account.
@ -473,8 +490,9 @@ account the response is "`200 OK`".
[[list-ssh-keys]] [[list-ssh-keys]]
List SSH Keys List SSH Keys
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'GET /accounts/link:#account-id[\{account-id\}]/sshkeys' 'GET /accounts/link:#account-id[\{account-id\}]/sshkeys'
--
Returns the SSH keys of an account. Returns the SSH keys of an account.
@ -508,8 +526,9 @@ link:#ssh-key-info[SshKeyInfo] entities.
[[get-ssh-key]] [[get-ssh-key]]
Get SSH Key Get SSH Key
~~~~~~~~~~~ ~~~~~~~~~~~
[verse] --
'GET /accounts/link:#account-id[\{account-id\}]/sshkeys/link:#ssh-key-id[\{ssh-key-id\}]' 'GET /accounts/link:#account-id[\{account-id\}]/sshkeys/link:#ssh-key-id[\{ssh-key-id\}]'
--
Retrieves an SSH key of a user. Retrieves an SSH key of a user.
@ -541,8 +560,9 @@ describes the SSH key.
[[add-ssh-key]] [[add-ssh-key]]
Add SSH Key Add SSH Key
~~~~~~~~~~~ ~~~~~~~~~~~
[verse] --
'POST /accounts/link:#account-id[\{account-id\}]/sshkeys' 'POST /accounts/link:#account-id[\{account-id\}]/sshkeys'
--
Adds an SSH key for a user. Adds an SSH key for a user.
@ -579,8 +599,9 @@ describes the new SSH key.
[[delete-ssh-key]] [[delete-ssh-key]]
Delete SSH Key Delete SSH Key
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
[verse] --
'DELETE /accounts/link:#account-id[\{account-id\}]/sshkeys/link:#ssh-key-id[\{ssh-key-id\}]' 'DELETE /accounts/link:#account-id[\{account-id\}]/sshkeys/link:#ssh-key-id[\{ssh-key-id\}]'
--
Deletes an SSH key of a user. Deletes an SSH key of a user.
@ -597,8 +618,9 @@ Deletes an SSH key of a user.
[[list-account-capabilities]] [[list-account-capabilities]]
List Account Capabilities List Account Capabilities
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
[verse] --
'GET /accounts/link:#account-id[\{account-id\}]/capabilities' 'GET /accounts/link:#account-id[\{account-id\}]/capabilities'
--
Returns the global capabilities that are enabled for the specified Returns the global capabilities that are enabled for the specified
user. user.
@ -702,8 +724,9 @@ get::/accounts/self/capabilities?q=createGroup
[[check-account-capability]] [[check-account-capability]]
Check Account Capability Check Account Capability
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
[verse] --
'GET /accounts/link:#account-id[\{account-id\}]/capabilities/link:#capability-id[\{capability-id\}]' 'GET /accounts/link:#account-id[\{account-id\}]/capabilities/link:#capability-id[\{capability-id\}]'
--
Checks if a user has a certain global capability. Checks if a user has a certain global capability.
@ -732,8 +755,9 @@ get::/accounts/self/capabilities/createGroup
[[list-groups]] [[list-groups]]
List Groups List Groups
~~~~~~~~~~~ ~~~~~~~~~~~
[verse] --
'GET /accounts/link:#account-id[\{account-id\}]/groups/' 'GET /accounts/link:#account-id[\{account-id\}]/groups/'
--
Lists all groups that contain the specified user as a member. Lists all groups that contain the specified user as a member.
@ -794,8 +818,9 @@ get::/accounts/self/groups/
[[get-avatar]] [[get-avatar]]
Get Avatar Get Avatar
~~~~~~~~~~ ~~~~~~~~~~
[verse] --
'GET /accounts/link:#account-id[\{account-id\}]/avatar' 'GET /accounts/link:#account-id[\{account-id\}]/avatar'
--
Retrieves the avatar image of the user. Retrieves the avatar image of the user.
@ -818,8 +843,9 @@ The response redirects to the URL of the avatar image.
[[get-avatar-change-url]] [[get-avatar-change-url]]
Get Avatar Change URL Get Avatar Change URL
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
[verse] --
'GET /accounts/link:#account-id[\{account-id\}]/avatar.change.url' 'GET /accounts/link:#account-id[\{account-id\}]/avatar.change.url'
--
Retrieves the URL where the user can change the avatar image. Retrieves the URL where the user can change the avatar image.
@ -840,8 +866,9 @@ Retrieves the URL where the user can change the avatar image.
[[get-diff-preferences]] [[get-diff-preferences]]
Get Diff Preferences Get Diff Preferences
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
[verse] --
'GET /accounts/link:#account-id[\{account-id\}]/preferences.diff' 'GET /accounts/link:#account-id[\{account-id\}]/preferences.diff'
--
Retrieves the diff preferences of a user. Retrieves the diff preferences of a user.
@ -875,8 +902,9 @@ link:#diff-preferences-info[DiffPreferencesInfo] entity.
[[set-diff-preferences]] [[set-diff-preferences]]
Set Diff Preferences Set Diff Preferences
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
[verse] --
'PUT /accounts/link:#account-id[\{account-id\}]/preferences.diff' 'PUT /accounts/link:#account-id[\{account-id\}]/preferences.diff'
--
Sets the diff preferences of a user. Sets the diff preferences of a user.
@ -927,8 +955,9 @@ link:#diff-preferences-info[DiffPreferencesInfo] entity.
[[get-starred-changes]] [[get-starred-changes]]
Get Starred Changes Get Starred Changes
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
[verse] --
'GET /accounts/link:#account-id[\{account-id\}]/starred.changes' 'GET /accounts/link:#account-id[\{account-id\}]/starred.changes'
--
Gets the changes starred by the identified user account. This Gets the changes starred by the identified user account. This
URL endpoint is functionally identical to the changes query URL endpoint is functionally identical to the changes query
@ -971,8 +1000,9 @@ link:rest-api-changes.html#change-info[ChangeInfo] entities.
[[star-change]] [[star-change]]
Star Change Star Change
~~~~~~~~~~~ ~~~~~~~~~~~
[verse] --
'PUT /accounts/link:#account-id[\{account-id\}]/starred.changes/link:rest-api-changes.html#change-id[\{change-id\}]' 'PUT /accounts/link:#account-id[\{account-id\}]/starred.changes/link:rest-api-changes.html#change-id[\{change-id\}]'
--
Star a change. Starred changes are returned for the search query Star a change. Starred changes are returned for the search query
`is:starred` or `starredby:USER` and automatically notify the user `is:starred` or `starredby:USER` and automatically notify the user
@ -991,8 +1021,9 @@ whenever updates are made to the change.
[[unstar-change]] [[unstar-change]]
Unstar Change Unstar Change
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'DELETE /accounts/link:#account-id[\{account-id\}]/starred.changes/link:rest-api-changes#change-id[\{change-id\}]' 'DELETE /accounts/link:#account-id[\{account-id\}]/starred.changes/link:rest-api-changes#change-id[\{change-id\}]'
--
Unstar a change. Removes the starred flag, stopping notifications. Unstar a change. Removes the starred flag, stopping notifications.

135
Documentation/rest-api-changes.txt
View File

@ -12,8 +12,9 @@ Change Endpoints
[[list-changes]] [[list-changes]]
Query Changes Query Changes
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'GET /changes/' 'GET /changes/'
--
Queries changes visible to the caller. The query string must be Queries changes visible to the caller. The query string must be
provided by the `q` parameter. The `n` parameter can be used to limit provided by the `q` parameter. The `n` parameter can be used to limit
@ -361,8 +362,9 @@ default. Optional fields are:
[[get-change]] [[get-change]]
Get Change Get Change
~~~~~~~~~~ ~~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]' 'GET /changes/link:#change-id[\{change-id\}]'
--
Retrieves a change. Retrieves a change.
@ -408,8 +410,9 @@ describes the change.
[[get-change-detail]] [[get-change-detail]]
Get Change Detail Get Change Detail
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/detail' 'GET /changes/link:#change-id[\{change-id\}]/detail'
--
Retrieves a change with link:#labels[labels], link:#detailed-labels[ Retrieves a change with link:#labels[labels], link:#detailed-labels[
detailed labels], link:#detailed-accounts[detailed accounts], and detailed labels], link:#detailed-accounts[detailed accounts], and
@ -576,8 +579,9 @@ describes the change.
[[get-topic]] [[get-topic]]
Get Topic Get Topic
~~~~~~~~~ ~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/topic' 'GET /changes/link:#change-id[\{change-id\}]/topic'
--
Retrieves the topic of a change. Retrieves the topic of a change.
@ -601,8 +605,9 @@ If the change does not have a topic an empty string is returned.
[[set-topic]] [[set-topic]]
Set Topic Set Topic
~~~~~~~~~ ~~~~~~~~~
[verse] --
'PUT /changes/link:#change-id[\{change-id\}]/topic' 'PUT /changes/link:#change-id[\{change-id\}]/topic'
--
Sets the topic of a change. Sets the topic of a change.
@ -636,8 +641,9 @@ If the topic was deleted the response is "`204 No Content`".
[[delete-topic]] [[delete-topic]]
Delete Topic Delete Topic
~~~~~~~~~~~~ ~~~~~~~~~~~~
[verse] --
'DELETE /changes/link:#change-id[\{change-id\}]/topic' 'DELETE /changes/link:#change-id[\{change-id\}]/topic'
--
Deletes the topic of a change. Deletes the topic of a change.
@ -661,8 +667,9 @@ link:#set-topic[PUT] to delete the topic.
[[abandon-change]] [[abandon-change]]
Abandon Change Abandon Change
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
[verse] --
'POST /changes/link:#change-id[\{change-id\}]/abandon' 'POST /changes/link:#change-id[\{change-id\}]/abandon'
--
Abandons a change. Abandons a change.
@ -719,8 +726,9 @@ the error message is contained in the response body.
[[restore-change]] [[restore-change]]
Restore Change Restore Change
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
[verse] --
'POST /changes/link:#change-id[\{change-id\}]/restore' 'POST /changes/link:#change-id[\{change-id\}]/restore'
--
Restores a change. Restores a change.
@ -777,8 +785,9 @@ the error message is contained in the response body.
[[rebase-change]] [[rebase-change]]
Rebase Change Rebase Change
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'POST /changes/link:#change-id[\{change-id\}]/rebase' 'POST /changes/link:#change-id[\{change-id\}]/rebase'
--
Rebases a change. Rebases a change.
@ -866,8 +875,9 @@ body.
[[revert-change]] [[revert-change]]
Revert Change Revert Change
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'POST /changes/link:#change-id[\{change-id\}]/revert' 'POST /changes/link:#change-id[\{change-id\}]/revert'
--
Reverts a change. Reverts a change.
@ -924,8 +934,9 @@ the error message is contained in the response body.
[[submit-change]] [[submit-change]]
Submit Change Submit Change
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'POST /changes/link:#change-id[\{change-id\}]/submit' 'POST /changes/link:#change-id[\{change-id\}]/submit'
--
Submits a change. Submits a change.
@ -987,8 +998,9 @@ message is contained in the response body.
[[publish-draft-change]] [[publish-draft-change]]
Publish Draft Change Publish Draft Change
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
[verse] --
'POST /changes/link:#change-id[\{change-id\}]/publish' 'POST /changes/link:#change-id[\{change-id\}]/publish'
--
Publishes a draft change. Publishes a draft change.
@ -1006,8 +1018,9 @@ Publishes a draft change.
[[delete-draft-change]] [[delete-draft-change]]
Delete Draft Change Delete Draft Change
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
[verse] --
'DELETE /changes/link:#change-id[\{change-id\}]' 'DELETE /changes/link:#change-id[\{change-id\}]'
--
Deletes a draft change. Deletes a draft change.
@ -1025,8 +1038,9 @@ Deletes a draft change.
[[get-included-in]] [[get-included-in]]
Get Included In Get Included In
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/in' 'GET /changes/link:#change-id[\{change-id\}]/in'
--
Retrieves the branches and tags in which a change is included. As result Retrieves the branches and tags in which a change is included. As result
an link:#included-in-info[IncludedInInfo] entity is returned. an link:#included-in-info[IncludedInInfo] entity is returned.
@ -1059,8 +1073,9 @@ Reviewer Endpoints
[[list-reviewers]] [[list-reviewers]]
List Reviewers List Reviewers
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/reviewers/' 'GET /changes/link:#change-id[\{change-id\}]/reviewers/'
--
Lists the reviewers of a change. Lists the reviewers of a change.
@ -1105,8 +1120,9 @@ As result a list of link:#reviewer-info[ReviewerInfo] entries is returned.
[[suggest-reviewers]] [[suggest-reviewers]]
Suggest Reviewers Suggest Reviewers
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/suggest_reviewers?q=J&n=5' 'GET /changes/link:#change-id[\{change-id\}]/suggest_reviewers?q=J&n=5'
--
Suggest the reviewers for a given query `q` and result limit `n`. If result Suggest the reviewers for a given query `q` and result limit `n`. If result
limit is not passed, then the default 10 is used. limit is not passed, then the default 10 is used.
@ -1147,8 +1163,9 @@ As result a list of link:#suggested-reviewer-info[SuggestedReviewerInfo] entries
[[get-reviewer]] [[get-reviewer]]
Get Reviewer Get Reviewer
~~~~~~~~~~~~ ~~~~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/reviewers/link:rest-api-accounts.html#account-id[\{account-id\}]' 'GET /changes/link:#change-id[\{change-id\}]/reviewers/link:rest-api-accounts.html#account-id[\{account-id\}]'
--
Retrieves a reviewer of a change. Retrieves a reviewer of a change.
@ -1182,8 +1199,9 @@ describes the reviewer.
[[add-reviewer]] [[add-reviewer]]
Add Reviewer Add Reviewer
~~~~~~~~~~~~ ~~~~~~~~~~~~
[verse] --
'POST /changes/link:#change-id[\{change-id\}]/reviewers' 'POST /changes/link:#change-id[\{change-id\}]/reviewers'
--
Adds one user or all members of one group as reviewer to the change. Adds one user or all members of one group as reviewer to the change.
@ -1273,8 +1291,9 @@ To confirm the addition of the reviewers, resend the request with the
[[delete-reviewer]] [[delete-reviewer]]
Delete Reviewer Delete Reviewer
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
[verse] --
'DELETE /changes/link:#change-id[\{change-id\}]/reviewers/link:rest-api-accounts.html#account-id[\{account-id\}]' 'DELETE /changes/link:#change-id[\{change-id\}]/reviewers/link:rest-api-accounts.html#account-id[\{account-id\}]'
--
Deletes a reviewer from a change. Deletes a reviewer from a change.
@ -1295,8 +1314,9 @@ Revision Endpoints
[[get-commit]] [[get-commit]]
Get Commit Get Commit
~~~~~~~~~~ ~~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/commit' 'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/commit'
--
Retrieves a parsed commit of a revision. Retrieves a parsed commit of a revision.
@ -1344,8 +1364,9 @@ describes the revision.
[[get-review]] [[get-review]]
Get Review Get Review
~~~~~~~~~~ ~~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/review' 'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/review'
--
Retrieves a review of a revision. Retrieves a review of a revision.
@ -1477,8 +1498,9 @@ for the current patch set.
[[set-review]] [[set-review]]
Set Review Set Review
~~~~~~~~~~ ~~~~~~~~~~
[verse] --
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/review' 'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/review'
--
Sets a review on a revision. Sets a review on a revision.
@ -1530,8 +1552,9 @@ describes the applied labels.
[[rebase-revision]] [[rebase-revision]]
Rebase Revision Rebase Revision
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
[verse] --
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/rebase' 'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/rebase'
--
Rebases a revision. Rebases a revision.
@ -1619,8 +1642,9 @@ body.
[[submit-revision]] [[submit-revision]]
Submit Revision Submit Revision
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
[verse] --
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/submit' 'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/submit'
--
Submits a revision. Submits a revision.
@ -1669,8 +1693,9 @@ message is contained in the response body.
[[publish-draft-revision]] [[publish-draft-revision]]
Publish Draft Revision Publish Draft Revision
~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
[verse] --
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/publish' 'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/publish'
--
Publishes a draft revision. Publishes a draft revision.
@ -1688,8 +1713,9 @@ Publishes a draft revision.
[[delete-draft-revision]] [[delete-draft-revision]]
Delete Draft Revision Delete Draft Revision
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
[verse] --
'DELETE /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]' 'DELETE /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]'
--
Deletes a draft revision. Deletes a draft revision.
@ -1707,8 +1733,9 @@ Deletes a draft revision.
[[get-patch]] [[get-patch]]
Get Patch Get Patch
~~~~~~~~~ ~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/patch' 'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/patch'
--
Gets the formatted patch for one revision. Gets the formatted patch for one revision.
@ -1742,8 +1769,9 @@ for later processing by command line tools.
[[get-mergeable]] [[get-mergeable]]
Get Mergeable Get Mergeable
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/mergeable' 'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/mergeable'
--
Gets the method the server will use to submit (merge) the change and Gets the method the server will use to submit (merge) the change and
an indicator if the change is currently mergeable. an indicator if the change is currently mergeable.
@ -1769,8 +1797,9 @@ an indicator if the change is currently mergeable.
[[get-submit-type]] [[get-submit-type]]
Get Submit Type Get Submit Type
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/submit_type' 'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/submit_type'
--
Gets the method the server will use to submit (merge) the change. Gets the method the server will use to submit (merge) the change.
@ -1792,8 +1821,9 @@ Gets the method the server will use to submit (merge) the change.
[[test-submit-type]] [[test-submit-type]]
Test Submit Type Test Submit Type
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
[verse] --
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/test.submit_type' 'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/test.submit_type'
--
Tests the submit_type Prolog rule in the project, or the one given. Tests the submit_type Prolog rule in the project, or the one given.
@ -1823,8 +1853,9 @@ a project-specific rule.
[[test-submit-rule]] [[test-submit-rule]]
Test Submit Rule Test Submit Rule
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
[verse] --
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/test.submit_rule' 'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/test.submit_rule'
--
Tests the submit_rule Prolog rule in the project, or the one given. Tests the submit_rule Prolog rule in the project, or the one given.
@ -1865,8 +1896,9 @@ describing the permutations that satisfy the tested submit rule.
[[list-drafts]] [[list-drafts]]
List Drafts List Drafts
~~~~~~~~~~~ ~~~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/' 'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/'
--
Lists the draft comments of a revision that belong to the calling Lists the draft comments of a revision that belong to the calling
user. user.
@ -1911,8 +1943,9 @@ sorted by file path.
[[create-draft]] [[create-draft]]
Create Draft Create Draft
~~~~~~~~~~~~ ~~~~~~~~~~~~
[verse] --
'PUT /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts' 'PUT /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts'
--
Creates a draft comment on a revision. Creates a draft comment on a revision.
@ -1954,8 +1987,9 @@ describes the draft comment.
[[get-draft]] [[get-draft]]
Get Draft Get Draft
~~~~~~~~~ ~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/link:#draft-id[\{draft-id\}]' 'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/link:#draft-id[\{draft-id\}]'
--
Retrieves a draft comment of a revision that belongs to the calling Retrieves a draft comment of a revision that belongs to the calling
user. user.
@ -1988,8 +2022,9 @@ describes the draft comment.
[[update-draft]] [[update-draft]]
Update Draft Update Draft
~~~~~~~~~~~~ ~~~~~~~~~~~~
[verse] --
'PUT /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/link:#draft-id[\{draft-id\}]' 'PUT /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/link:#draft-id[\{draft-id\}]'
--
Updates a draft comment on a revision. Updates a draft comment on a revision.
@ -2031,8 +2066,9 @@ describes the draft comment.
[[delete-draft]] [[delete-draft]]
Delete Draft Delete Draft
~~~~~~~~~~~~ ~~~~~~~~~~~~
[verse] --
'DELETE /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/link:#draft-id[\{draft-id\}]' 'DELETE /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/link:#draft-id[\{draft-id\}]'
--
Deletes a draft comment from a revision. Deletes a draft comment from a revision.
@ -2049,8 +2085,9 @@ Deletes a draft comment from a revision.
[[list-comments]] [[list-comments]]
List Comments List Comments
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/comments/' 'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/comments/'
--
Lists the published comments of a revision. Lists the published comments of a revision.
@ -2104,8 +2141,9 @@ sorted by file path.
[[get-comment]] [[get-comment]]
Get Comment Get Comment
~~~~~~~~~~~ ~~~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/comments/link:#comment-id[\{comment-id\}]' 'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/comments/link:#comment-id[\{comment-id\}]'
--
Retrieves a published comment of a revision. Retrieves a published comment of a revision.
@ -2142,8 +2180,9 @@ describes the published comment.
[[list-files]] [[list-files]]
List Files List Files
~~~~~~~~~~ ~~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/' 'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/'
--
Lists the files that were modified, added or deleted in a revision. Lists the files that were modified, added or deleted in a revision.
@ -2200,8 +2239,9 @@ need the FileInfo should make two requests.
[[get-content]] [[get-content]]
Get Content Get Content
~~~~~~~~~~~ ~~~~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/content' 'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/content'
--
Gets the content of a file from a certain revision. Gets the content of a file from a certain revision.
@ -2224,8 +2264,9 @@ The content is returned as base64 encoded string.
[[get-diff]] [[get-diff]]
Get Diff Get Diff
~~~~~~~~ ~~~~~~~~
[verse] --
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/diff' 'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/diff'
--
Gets the diff of a file from a certain revision. Gets the diff of a file from a certain revision.
@ -2390,8 +2431,9 @@ in the diff. Valid values are `ALL` or number of lines.
[[set-reviewed]] [[set-reviewed]]
Set Reviewed Set Reviewed
~~~~~~~~~~~~ ~~~~~~~~~~~~
[verse] --
'PUT /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/reviewed' 'PUT /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/reviewed'
--
Marks a file of a revision as reviewed by the calling user. Marks a file of a revision as reviewed by the calling user.
@ -2411,8 +2453,9 @@ response is "`200 OK`".
[[delete-reviewed]] [[delete-reviewed]]
Delete Reviewed Delete Reviewed
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
[verse] --
'DELETE /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/reviewed' 'DELETE /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/reviewed'
--
Deletes the reviewed flag of the calling user from a file of a revision. Deletes the reviewed flag of the calling user from a file of a revision.
@ -2429,8 +2472,9 @@ Deletes the reviewed flag of the calling user from a file of a revision.
[[cherry-pick]] [[cherry-pick]]
Cherry Pick Revision Cherry Pick Revision
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
[verse] --
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/cherrypick' 'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/cherrypick'
--
Cherry picks a revision to a destination branch. Cherry picks a revision to a destination branch.
@ -2480,8 +2524,9 @@ describes the resulting cherry picked change.
[[message]] [[message]]
Edit Commit Message Edit Commit Message
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
[verse] --
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/message' 'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/message'
--
Edit commit message. Edit commit message.

9
Documentation/rest-api-config.txt
View File

@ -12,8 +12,9 @@ Config Endpoints
[[get-version]] [[get-version]]
Get Version Get Version
~~~~~~~~~~~ ~~~~~~~~~~~
[verse] --
'GET /config/server/version' 'GET /config/server/version'
--
Returns the version of the Gerrit server. Returns the version of the Gerrit server.
@ -34,8 +35,9 @@ Returns the version of the Gerrit server.
[[list-capabilities]] [[list-capabilities]]
List Capabilities List Capabilities
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
[verse] --
'GET /config/server/capabilities' 'GET /config/server/capabilities'
--
Lists the capabilities that are available in the system. There are two Lists the capabilities that are available in the system. There are two
kinds of capabilities: core and plugin-owned capabilities. kinds of capabilities: core and plugin-owned capabilities.
@ -138,8 +140,9 @@ The entries in the map are sorted by capability ID.
[[get-top-menus]] [[get-top-menus]]
Get Top Menus Get Top Menus
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'GET /config/server/top-menus' 'GET /config/server/top-menus'
--
Returns the list of additional top menu entries. Returns the list of additional top menu entries.

3
Documentation/rest-api-documentation.txt
View File

@ -19,8 +19,9 @@ Documentation Search Endpoints
[[search-documentation]] [[search-documentation]]
Search Documentation Search Documentation
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
[verse] --
'GET /Documentation/' 'GET /Documentation/'
--
With `q` parameter, search our documentation index for the terms. With `q` parameter, search our documentation index for the terms.

81
Documentation/rest-api-groups.txt
View File

@ -12,8 +12,9 @@ Group Endpoints
[[list-groups]] [[list-groups]]
List Groups List Groups
~~~~~~~~~~~ ~~~~~~~~~~~
[verse] --
'GET /groups/' 'GET /groups/'
--
Lists the groups accessible by the caller. This is the same as Lists the groups accessible by the caller. This is the same as
using the link:cmd-ls-groups.html[ls-groups] command over SSH, using the link:cmd-ls-groups.html[ls-groups] command over SSH,
@ -168,8 +169,9 @@ returned.
[[get-group]] [[get-group]]
Get Group Get Group
~~~~~~~~~ ~~~~~~~~~
[verse] --
'GET /groups/link:#group-id[\{group-id\}]' 'GET /groups/link:#group-id[\{group-id\}]'
--
Retrieves a group. Retrieves a group.
@ -205,8 +207,9 @@ describes the group.
[[create-group]] [[create-group]]
Create Group Create Group
~~~~~~~~~~~~ ~~~~~~~~~~~~
[verse] --
'PUT /groups/link:#group-name[\{group-name\}]' 'PUT /groups/link:#group-name[\{group-name\}]'
--
Creates a new Gerrit internal group. Creates a new Gerrit internal group.
@ -257,8 +260,9 @@ response is "`409 Conflict`".
[[get-group-detail]] [[get-group-detail]]
Get Group Detail Get Group Detail
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
[verse] --
'GET /groups/link:#group-id[\{group-id\}]/detail' 'GET /groups/link:#group-id[\{group-id\}]/detail'
--
Retrieves a group with the direct link:#members[members] and the Retrieves a group with the direct link:#members[members] and the
directly link:#includes[included groups]. directly link:#includes[included groups].
@ -310,8 +314,9 @@ describes the group.
[[get-group-name]] [[get-group-name]]
Get Group Name Get Group Name
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
[verse] --
'GET /groups/link:#group-id[\{group-id\}]/name' 'GET /groups/link:#group-id[\{group-id\}]/name'
--
Retrieves the name of a group. Retrieves the name of a group.
@ -333,8 +338,9 @@ Retrieves the name of a group.
[[rename-group]] [[rename-group]]
Rename Group Rename Group
~~~~~~~~~~~~ ~~~~~~~~~~~~
[verse] --
'PUT /groups/link:#group-id[\{group-id\}]/name' 'PUT /groups/link:#group-id[\{group-id\}]/name'
--
Renames a Gerrit internal group. Renames a Gerrit internal group.
@ -368,8 +374,9 @@ response is "`409 Conflict`".
[[get-group-description]] [[get-group-description]]
Get Group Description Get Group Description
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
[verse] --
'GET /groups/link:#group-id[\{group-id\}]/description' 'GET /groups/link:#group-id[\{group-id\}]/description'
--
Retrieves the description of a group. Retrieves the description of a group.
@ -393,8 +400,9 @@ If the group does not have a description an empty string is returned.
[[set-group-description]] [[set-group-description]]
Set Group Description Set Group Description
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
[verse] --
'PUT /groups/link:#group-id[\{group-id\}]/description' 'PUT /groups/link:#group-id[\{group-id\}]/description'
--
Sets the description of a Gerrit internal group. Sets the description of a Gerrit internal group.
@ -427,8 +435,9 @@ If the description was deleted the response is "`204 No Content`".
[[delete-group-description]] [[delete-group-description]]
Delete Group Description Delete Group Description
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
[verse] --
'DELETE /groups/link:#group-id[\{group-id\}]/description' 'DELETE /groups/link:#group-id[\{group-id\}]/description'
--
Deletes the description of a Gerrit internal group. Deletes the description of a Gerrit internal group.
@ -445,8 +454,9 @@ Deletes the description of a Gerrit internal group.
[[get-group-options]] [[get-group-options]]
Get Group Options Get Group Options
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
[verse] --
'GET /groups/link:#group-id[\{group-id\}]/options' 'GET /groups/link:#group-id[\{group-id\}]/options'
--
Retrieves the options of a group. Retrieves the options of a group.
@ -473,8 +483,9 @@ returned that describes the options of the group.
[[set-group-options]] [[set-group-options]]
Set Group Options Set Group Options
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
[verse] --
'PUT /groups/link:#group-id[\{group-id\}]/options' 'PUT /groups/link:#group-id[\{group-id\}]/options'
--
Sets the options of a Gerrit internal group. Sets the options of a Gerrit internal group.
@ -509,8 +520,9 @@ link:#group-options-info[GroupOptionsInfo] entity.
[[get-group-owner]] [[get-group-owner]]
Get Group Owner Get Group Owner
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
[verse] --
'GET /groups/link:#group-id[\{group-id\}]/owner' 'GET /groups/link:#group-id[\{group-id\}]/owner'
--
Retrieves the owner group of a Gerrit internal group. Retrieves the owner group of a Gerrit internal group.
@ -546,8 +558,9 @@ describes the owner group.
[[set-group-owner]] [[set-group-owner]]
Set Group Owner Set Group Owner
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
[verse] --
'PUT /groups/link:#group-id[\{group-id\}]/owner' 'PUT /groups/link:#group-id[\{group-id\}]/owner'
--
Sets the owner group of a Gerrit internal group. Sets the owner group of a Gerrit internal group.
@ -597,8 +610,9 @@ Group Member Endpoints
[[group-members]] [[group-members]]
List Group Members List Group Members
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
[verse] --
'GET /groups/link:#group-id[\{group-id\}]/members/' 'GET /groups/link:#group-id[\{group-id\}]/members/'
--
Lists the direct members of a Gerrit internal group. Lists the direct members of a Gerrit internal group.
@ -682,8 +696,9 @@ are not visible to the calling user are ignored.
[[get-group-member]] [[get-group-member]]
Get Group Member Get Group Member
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
[verse] --
'GET /groups/link:#group-id[\{group-id\}]/members/link:rest-api-accounts.html#account-id[\{account-id\}]' 'GET /groups/link:#group-id[\{group-id\}]/members/link:rest-api-accounts.html#account-id[\{account-id\}]'
--
Retrieves a group member. Retrieves a group member.
@ -713,8 +728,9 @@ AccountInfo] entity is returned that describes the group member.
[[add-group-member]] [[add-group-member]]
Add Group Member Add Group Member
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
[verse] --
'PUT /groups/link:#group-id[\{group-id\}]/members/link:rest-api-accounts.html#account-id[\{account-id\}]' 'PUT /groups/link:#group-id[\{group-id\}]/members/link:rest-api-accounts.html#account-id[\{account-id\}]'
--
Adds a user as member to a Gerrit internal group. Adds a user as member to a Gerrit internal group.
@ -746,13 +762,15 @@ group, but then the HTTP response code is `200 OK`.
Add Group Members Add Group Members
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
[verse] --
'POST /groups/link:#group-id[\{group-id\}]/members' 'POST /groups/link:#group-id[\{group-id\}]/members'
--
OR OR
[verse] --
'POST /groups/link:#group-id[\{group-id\}]/members.add' 'POST /groups/link:#group-id[\{group-id\}]/members.add'
--
Adds one or several users to a Gerrit internal group. Adds one or several users to a Gerrit internal group.
@ -806,8 +824,9 @@ already a member of the group.
[[delete-group-member]] [[delete-group-member]]
Delete Group Member Delete Group Member
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
[verse] --
'DELETE /groups/link:#group-id[\{group-id\}]/members/link:rest-api-accounts.html#account-id[\{account-id\}]' 'DELETE /groups/link:#group-id[\{group-id\}]/members/link:rest-api-accounts.html#account-id[\{account-id\}]'
--
Deletes a user from a Gerrit internal group. Deletes a user from a Gerrit internal group.
@ -824,8 +843,9 @@ Deletes a user from a Gerrit internal group.
[[delete-group-members]] [[delete-group-members]]
Delete Group Members Delete Group Members
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
[verse] --
'POST /groups/link:#group-id[\{group-id\}]/members.delete' 'POST /groups/link:#group-id[\{group-id\}]/members.delete'
--
Delete one or several users from a Gerrit internal group. Delete one or several users from a Gerrit internal group.
@ -857,8 +877,9 @@ Group Include Endpoints
[[included-groups]] [[included-groups]]
List Included Groups List Included Groups
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
[verse] --
'GET /groups/link:#group-id[\{group-id\}]/groups/' 'GET /groups/link:#group-id[\{group-id\}]/groups/'
--
Lists the directly included groups of a group. Lists the directly included groups of a group.
@ -895,8 +916,9 @@ The entries in the list are sorted by group name and UUID.
[[get-included-group]] [[get-included-group]]
Get Included Group Get Included Group
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
[verse] --
'GET /groups/link:#group-id[\{group-id\}]/groups/link:#group-id[\{group-id\}]' 'GET /groups/link:#group-id[\{group-id\}]/groups/link:#group-id[\{group-id\}]'
--
Retrieves an included group. Retrieves an included group.
@ -931,8 +953,9 @@ describes the included group.
[[include-group]] [[include-group]]
Include Group Include Group
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'PUT /groups/link:#group-id[\{group-id\}]/groups/link:#group-id[\{group-id\}]' 'PUT /groups/link:#group-id[\{group-id\}]/groups/link:#group-id[\{group-id\}]'
--
Includes an internal or external group into a Gerrit internal group. Includes an internal or external group into a Gerrit internal group.
External groups must be specified using the UUID. External groups must be specified using the UUID.
@ -971,13 +994,15 @@ group, but then the HTTP response code is `200 OK`.
[[include-groups]] [[include-groups]]
Include Groups Include Groups
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
[verse] --
'POST /groups/link:#group-id[\{group-id\}]/groups' 'POST /groups/link:#group-id[\{group-id\}]/groups'
--
OR OR
[verse] --
'POST /groups/link:#group-id[\{group-id\}]/groups.add' 'POST /groups/link:#group-id[\{group-id\}]/groups.add'
--
Includes one or several groups into a Gerrit internal group. Includes one or several groups into a Gerrit internal group.
@ -1040,8 +1065,9 @@ group was already included in the group.
[[delete-included-group]] [[delete-included-group]]
Delete Included Group Delete Included Group
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
[verse] --
'DELETE /groups/link:#group-id[\{group-id\}]/groups/link:#group-id[\{group-id\}]' 'DELETE /groups/link:#group-id[\{group-id\}]/groups/link:#group-id[\{group-id\}]'
--
Deletes an included group from a Gerrit internal group. Deletes an included group from a Gerrit internal group.
@ -1058,8 +1084,9 @@ Deletes an included group from a Gerrit internal group.
[[delete-included-groups]] [[delete-included-groups]]
Delete Included Groups Delete Included Groups
~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
[verse] --
'POST /groups/link:#group-id[\{group-id\}]/groups.delete' 'POST /groups/link:#group-id[\{group-id\}]/groups.delete'
--
Delete one or several included groups from a Gerrit internal group. Delete one or several included groups from a Gerrit internal group.

21
Documentation/rest-api-plugins.txt
View File

@ -19,8 +19,9 @@ namespace.
[[list-plugins]] [[list-plugins]]
List Plugins List Plugins
~~~~~~~~~~~~ ~~~~~~~~~~~~
[verse] --
'GET /plugins/' 'GET /plugins/'
--
Lists the plugins installed on the Gerrit server. Only the enabled Lists the plugins installed on the Gerrit server. Only the enabled
plugins are returned unless the `all` option is specified. plugins are returned unless the `all` option is specified.
@ -59,8 +60,9 @@ by plugin ID.
[[install-plugin]] [[install-plugin]]
Install Plugin Install Plugin
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
[verse] --
'PUT /plugins/link:#plugin-id[\{plugin-id\}]' 'PUT /plugins/link:#plugin-id[\{plugin-id\}]'
--
Installs a new plugin on the Gerrit server. If a plugin with the Installs a new plugin on the Gerrit server. If a plugin with the
specified name already exists it is overwritten. Note: if the plugin specified name already exists it is overwritten. Note: if the plugin
@ -110,8 +112,9 @@ If an existing plugin was overwritten the response is "`200 OK`".
[[get-plugin-status]] [[get-plugin-status]]
Get Plugin Status Get Plugin Status
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
[verse] --
'GET /plugins/link:#plugin-id[\{plugin-id\}]/gerrit~status' 'GET /plugins/link:#plugin-id[\{plugin-id\}]/gerrit~status'
--
Retrieves the status of a plugin on the Gerrit server. Retrieves the status of a plugin on the Gerrit server.
@ -140,8 +143,9 @@ describes the plugin.
[[enable-plugin]] [[enable-plugin]]
Enable Plugin Enable Plugin
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'POST /plugins/link:#plugin-id[\{plugin-id\}]/gerrit~enable' 'POST /plugins/link:#plugin-id[\{plugin-id\}]/gerrit~enable'
--
Enables a plugin on the Gerrit server. Enables a plugin on the Gerrit server.
@ -170,13 +174,15 @@ describes the plugin.
[[disable-plugin]] [[disable-plugin]]
Disable Plugin Disable Plugin
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
[verse] --
'POST /plugins/link:#plugin-id[\{plugin-id\}]/gerrit~disable' 'POST /plugins/link:#plugin-id[\{plugin-id\}]/gerrit~disable'
--
OR OR
[verse] --
'DELETE /plugins/link:#plugin-id[\{plugin-id\}]' 'DELETE /plugins/link:#plugin-id[\{plugin-id\}]'
--
Disables a plugin on the Gerrit server. Disables a plugin on the Gerrit server.
@ -206,8 +212,9 @@ describes the plugin.
[[reload-plugin]] [[reload-plugin]]
Reload Plugin Reload Plugin
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'POST /plugins/link:#plugin-id[\{plugin-id\}]/gerrit~reload' 'POST /plugins/link:#plugin-id[\{plugin-id\}]/gerrit~reload'
--
Reloads a plugin on the Gerrit server. Reloads a plugin on the Gerrit server.

72
Documentation/rest-api-projects.txt
View File

@ -12,8 +12,9 @@ Project Endpoints
[[list-projects]] [[list-projects]]
List Projects List Projects
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'GET /projects/' 'GET /projects/'
--
Lists the projects accessible by the caller. This is the same as Lists the projects accessible by the caller. This is the same as
using the link:cmd-ls-projects.html[ls-projects] command over SSH, using the link:cmd-ls-projects.html[ls-projects] command over SSH,
@ -97,8 +98,9 @@ E.g. this feature can be used by suggestion client UI's to limit results.
[[get-project]] [[get-project]]
Get Project Get Project
~~~~~~~~~~~ ~~~~~~~~~~~
[verse] --
'GET /projects/link:#project-name[\{project-name\}]' 'GET /projects/link:#project-name[\{project-name\}]'
--
Retrieves a project. Retrieves a project.
@ -129,8 +131,9 @@ describes the project.
[[create-project]] [[create-project]]
Create Project Create Project
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
[verse] --
'PUT /projects/link:#project-name[\{project-name\}]' 'PUT /projects/link:#project-name[\{project-name\}]'
--
Creates a new project. Creates a new project.
@ -173,8 +176,9 @@ describes the created project.
[[get-project-description]] [[get-project-description]]
Get Project Description Get Project Description
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
[verse] --
'GET /projects/link:#project-name[\{project-name\}]/description' 'GET /projects/link:#project-name[\{project-name\}]/description'
--
Retrieves the description of a project. Retrieves the description of a project.
@ -198,8 +202,9 @@ If the project does not have a description an empty string is returned.
[[set-project-description]] [[set-project-description]]
Set Project Description Set Project Description
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
[verse] --
'PUT /projects/link:#project-name[\{project-name\}]/description' 'PUT /projects/link:#project-name[\{project-name\}]/description'
--
Sets the description of a project. Sets the description of a project.
@ -234,8 +239,9 @@ If the description was deleted the response is "`204 No Content`".
[[delete-project-description]] [[delete-project-description]]
Delete Project Description Delete Project Description
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
[verse] --
'DELETE /projects/link:#project-name[\{project-name\}]/description' 'DELETE /projects/link:#project-name[\{project-name\}]/description'
--
Deletes the description of a project. Deletes the description of a project.
@ -260,8 +266,9 @@ link:#set-project-description[PUT] to delete the description.
[[get-project-parent]] [[get-project-parent]]
Get Project Parent Get Project Parent
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
[verse] --
'GET /projects/link:#project-name[\{project-name\}]/parent' 'GET /projects/link:#project-name[\{project-name\}]/parent'
--
Retrieves the name of a project's parent project. For the Retrieves the name of a project's parent project. For the
`All-Projects` root project an empty string is returned. `All-Projects` root project an empty string is returned.
@ -284,8 +291,9 @@ Retrieves the name of a project's parent project. For the
[[set-project-parent]] [[set-project-parent]]
Set Project Parent Set Project Parent
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
[verse] --
'PUT /projects/link:#project-name[\{project-name\}]/parent' 'PUT /projects/link:#project-name[\{project-name\}]/parent'
--
Sets the parent project for a project. Sets the parent project for a project.
@ -318,8 +326,9 @@ As response the new parent project name is returned.
[[get-head]] [[get-head]]
Get HEAD Get HEAD
~~~~~~~~ ~~~~~~~~
[verse] --
'GET /projects/link:#project-name[\{project-name\}]/HEAD' 'GET /projects/link:#project-name[\{project-name\}]/HEAD'
--
Retrieves for a project the name of the branch to which `HEAD` points. Retrieves for a project the name of the branch to which `HEAD` points.
@ -341,8 +350,9 @@ Retrieves for a project the name of the branch to which `HEAD` points.
[[set-head]] [[set-head]]
Set HEAD Set HEAD
~~~~~~~~ ~~~~~~~~
[verse] --
'PUT /projects/link:#project-name[\{project-name\}]/HEAD' 'PUT /projects/link:#project-name[\{project-name\}]/HEAD'
--
Sets `HEAD` for a project. Sets `HEAD` for a project.
@ -374,8 +384,9 @@ As response the new ref to which `HEAD` points is returned.
[[get-repository-statistics]] [[get-repository-statistics]]
Get Repository Statistics Get Repository Statistics
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
[verse] --
'GET /projects/link:#project-name[\{project-name\}]/statistics.git' 'GET /projects/link:#project-name[\{project-name\}]/statistics.git'
--
Return statistics for the repository of a project. Return statistics for the repository of a project.
@ -408,8 +419,9 @@ link:#repository-statistics-info[RepositoryStatisticsInfo] entity.
[[get-config]] [[get-config]]
Get Config Get Config
~~~~~~~~~~ ~~~~~~~~~~
[verse] --
'GET /projects/link:#project-name[\{project-name\}]/config' 'GET /projects/link:#project-name[\{project-name\}]/config'
--
Gets some configuration information about a project. Note that this Gets some configuration information about a project. Note that this
config info is not simply the contents of `project.config`; it generally config info is not simply the contents of `project.config`; it generally
@ -476,8 +488,9 @@ read access to `refs/meta/config`.
[[set-config]] [[set-config]]
Set Config Set Config
~~~~~~~~~~ ~~~~~~~~~~
[verse] --
'PUT /projects/link:#project-name[\{project-name\}]/config' 'PUT /projects/link:#project-name[\{project-name\}]/config'
--
Sets the configuration of a project. Sets the configuration of a project.
@ -547,8 +560,9 @@ ConfigInfo] entity.
[[run-gc]] [[run-gc]]
Run GC Run GC
~~~~~~ ~~~~~~
[verse] --
'POST /projects/link:#project-name[\{project-name\}]/gc' 'POST /projects/link:#project-name[\{project-name\}]/gc'
--
Run the Git garbage collection for the repository of a project. Run the Git garbage collection for the repository of a project.
@ -598,8 +612,9 @@ Branch Endpoints
[[list-branches]] [[list-branches]]
List Branches List Branches
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'GET /projects/link:#project-name[\{project-name\}]/branches/' 'GET /projects/link:#project-name[\{project-name\}]/branches/'
--
List the branches of a project. List the branches of a project.
@ -642,8 +657,9 @@ returned.
[[get-branch]] [[get-branch]]
Get Branch Get Branch
~~~~~~~~~~ ~~~~~~~~~~
[verse] --
'GET /projects/link:#project-name[\{project-name\}]/branches/link:#branch-id[\{branch-id\}]' 'GET /projects/link:#project-name[\{project-name\}]/branches/link:#branch-id[\{branch-id\}]'
--
Retrieves a branch of a project. Retrieves a branch of a project.
@ -671,8 +687,9 @@ describes the branch.
[[create-branch]] [[create-branch]]
Create Branch Create Branch
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'PUT /projects/link:#project-name[\{project-name\}]/branches/link:#branch-id[\{branch-id\}]' 'PUT /projects/link:#project-name[\{project-name\}]/branches/link:#branch-id[\{branch-id\}]'
--
Creates a new branch. Creates a new branch.
@ -709,8 +726,9 @@ describes the created branch.
[[delete-branch]] [[delete-branch]]
Delete Branch Delete Branch
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'DELETE /projects/link:#project-name[\{project-name\}]/branches/link:#branch-id[\{branch-id\}]' 'DELETE /projects/link:#project-name[\{project-name\}]/branches/link:#branch-id[\{branch-id\}]'
--
Deletes a branch. Deletes a branch.
@ -731,8 +749,9 @@ Child Project Endpoints
[[list-child-projects]] [[list-child-projects]]
List Child Projects List Child Projects
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
[verse] --
'GET /projects/link:#project-name[\{project-name\}]/children/' 'GET /projects/link:#project-name[\{project-name\}]/children/'
--
List the direct child projects of a project. List the direct child projects of a project.
@ -836,8 +855,9 @@ are not resolved further.
[[get-child-project]] [[get-child-project]]
Get Child Project Get Child Project
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
[verse] --
'GET /projects/link:#project-name[\{project-name\}]/children/link:#project-name[\{project-name\}]' 'GET /projects/link:#project-name[\{project-name\}]/children/link:#project-name[\{project-name\}]'
--
Retrieves a child project. If a non-direct child project should be Retrieves a child project. If a non-direct child project should be
retrieved the parameter `recursive` must be set. retrieved the parameter `recursive` must be set.
@ -873,8 +893,9 @@ Dashboard Endpoints
[[list-dashboards]] [[list-dashboards]]
List Dashboards List Dashboards
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
[verse] --
'GET /projects/link:#project-name[\{project-name\}]/dashboards/' 'GET /projects/link:#project-name[\{project-name\}]/dashboards/'
--
List custom dashboards for a project. List custom dashboards for a project.
@ -927,8 +948,9 @@ get::/projects/All-Projects/dashboards/
[[get-dashboard]] [[get-dashboard]]
Get Dashboard Get Dashboard
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'GET /projects/link:#project-name[\{project-name\}]/dashboards/link:#dashboard-id[\{dashboard-id\}]' 'GET /projects/link:#project-name[\{project-name\}]/dashboards/link:#dashboard-id[\{dashboard-id\}]'
--
Retrieves a project dashboard. The dashboard can be defined on that Retrieves a project dashboard. The dashboard can be defined on that
project or be inherited from a parent project. project or be inherited from a parent project.
@ -1010,8 +1032,9 @@ dashboard-id.
[[set-dashboard]] [[set-dashboard]]
Set Dashboard Set Dashboard
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
[verse] --
'PUT /projects/link:#project-name[\{project-name\}]/dashboards/link:#dashboard-id[\{dashboard-id\}]' 'PUT /projects/link:#project-name[\{project-name\}]/dashboards/link:#dashboard-id[\{dashboard-id\}]'
--
Updates/Creates a project dashboard. Updates/Creates a project dashboard.
@ -1066,8 +1089,9 @@ link:#dashboard-info[DashboardInfo] entity.
[[delete-dashboard]] [[delete-dashboard]]
Delete Dashboard Delete Dashboard
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
[verse] --
'DELETE /projects/link:#project-name[\{project-name\}]/dashboards/link:#dashboard-id[\{dashboard-id\}]' 'DELETE /projects/link:#project-name[\{project-name\}]/dashboards/link:#dashboard-id[\{dashboard-id\}]'
--
Deletes a project dashboard. Deletes a project dashboard.