Gerrit Code Review

https://review.lineageos.org/Documentation/
Admin
Gerrit Code Review is a web-based code review and repository hosting tool designed for Git-based...
Tokens:204,792
Snippets:2,611
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Plugin Installation Response

Source: https://review.lineageos.org/Documentation/rest-api-plugins.html

Example response returned after a successful plugin installation.

```http
  HTTP/1.1 201 Created
  Content-Disposition: attachment
  Content-Type: application/json;charset=utf-8
  Content-Length: 150

  )]}'
  {
    "id": "delete-project",
    "version": "v2.16-221-g35bb8bbac4",
    "index_url": "plugins/delete-project/",
    "filename": "delete-project.jar"
  }
```

--------------------------------

### Build and Install Snapshot

Source: https://review.lineageos.org/Documentation/dev-release-subproject.html

Builds the latest snapshot and installs it into the local Maven repository.

```bash
mvn clean install
```

--------------------------------

### Install Plugin from URL

Source: https://review.lineageos.org/Documentation/cmd-plugin-install.html

Downloads and installs a plugin from a specified HTTP or FTP URL.

```bash
ssh -p 29418 localhost gerrit plugin install -n name.jar http://build-server/output/our-plugin
```

--------------------------------

### Index changes in project example

Source: https://review.lineageos.org/Documentation/cmd-index-changes-in-project.html

Example command to index all changes for the projects MyProject and NiceProject.

```bash
$ ssh -p 29418 user@review.example.com gerrit index changes-in-project MyProject NiceProject
```

--------------------------------

### Specific Example of Obtaining the Hook

Source: https://review.lineageos.org/Documentation/cmd-hook-commit-msg.html

A concrete example of downloading the hook script to a local project directory.

```bash
$ scp -p -P 29418 john.doe@review.example.com:hooks/commit-msg ~/duhproject/.git/hooks/

$ curl -Lo ~/duhproject/.git/hooks/commit-msg http://review.example.com/tools/hooks/commit-msg
```

--------------------------------

### Example project.config file structure

Source: https://review.lineageos.org/Documentation/config-project-config.html

A comprehensive example showing project settings, access rules, label definitions, and submit requirements.

```ini
[project]
  description = Collection of scripts for setting up foo bar.
[access "refs/*"]
  read = group Registered Users
[access "refs/heads/*"]
  label-Code-Review = -2..+2 group Maintainers
  label-Code-Review = -1..+1 group Registered Users
  label-Your-Label = -1..+1 group Maintainers
[receive]
  requireChangeId = true
[label "Your-Label"]
  function = NoOp
  value = -1 Your -1 Description
  value =  0 Your No score Description
  value = +1 Your +1 Description
[submit-requirement "Your-Label"]
  description = At least one maximum vote for label 'Your-Label' is required
  applicableIf = -branch:refs/meta/config
  submittableIf = label:Your-Label=MAX AND -label:Your-Label=MIN
```

--------------------------------

### Change Project HEAD Example

Source: https://review.lineageos.org/Documentation/cmd-set-head.html

Example command to update the HEAD of the 'example' project to the 'stable-2.11' branch.

```bash
$ ssh -p 29418 review.example.com gerrit set-head example --new-head stable-2.11
```

--------------------------------

### Install API to Maven Repository

Source: https://review.lineageos.org/Documentation/dev-bazel.html

Install API components or the WAR file to the local Maven repository.

```bash
  tools/maven/api.sh install
```

```bash
  tools/maven/api.sh war_install
```

--------------------------------

### Install Plugin from Piped Input

Source: https://review.lineageos.org/Documentation/cmd-plugin-install.html

Installs a plugin by piping the file content directly into the command.

```bash
ssh -p 29418 localhost gerrit plugin install -n name.jar - <target/name-0.1.jar
```

--------------------------------

### List Access Rights Request

Source: https://review.lineageos.org/Documentation/rest-api-access.html

Example of a GET request to retrieve access rights for multiple projects.

```http
  GET /access/?project=MyProject&project=All-Projects HTTP/1.0
```

--------------------------------

### Update project settings example

Source: https://review.lineageos.org/Documentation/cmd-set-project.html

Example command to modify project visibility, change-id requirements, content merge settings, and submit type.

```bash
$ ssh -p 29418 review.example.com gerrit set-project example --submit-type MERGE_IF_NECESSARY \
  --change-id true --content-merge false --project-state HIDDEN
```

--------------------------------

### Install Plugin from Local Path

Source: https://review.lineageos.org/Documentation/cmd-plugin-install.html

Installs a plugin jar or js file from an absolute path on the server host.

```bash
ssh -p 29418 localhost gerrit plugin install -n name.jar $(pwd)/my-plugin.jar
```

```bash
ssh -p 29418 localhost gerrit plugin install -n name.js $(pwd)/my-webui-plugin.js
```

--------------------------------

### Add Email and SSH Key Example

Source: https://review.lineageos.org/Documentation/cmd-set-account.html

Example of adding an SSH key from a file and an email address to a specific user account.

```bash
$ cat ~/.ssh/id_watcher.pub | ssh -p 29418 review.example.com gerrit set-account --add-ssh-key - --add-email mail@example.com watcher
```

--------------------------------

### Activate Change Index Example

Source: https://review.lineageos.org/Documentation/cmd-index-activate.html

Example command to activate the changes index on a Gerrit server.

```bash
$ ssh -p 29418 review.example.com gerrit index activate changes
```

--------------------------------

### Install Plugin via Binary Data

Source: https://review.lineageos.org/Documentation/rest-api-plugins.html

Installs a plugin by sending the JAR file as binary data using curl.

```bash
  curl --user admin:TNNuLkWsIV8w -X PUT -H "Content-Type:application/octet-stream" --data-binary @delete-project.jar 'http://gerrit:8080/a/plugins/delete-project.jar'
```

--------------------------------

### Install Plugin via URL

Source: https://review.lineageos.org/Documentation/rest-api-plugins.html

Installs a plugin by providing a URL to the JAR file in the request body.

```http
  PUT /plugins/delete-project.jar HTTP/1.0
  Content-Type: application/json; charset=UTF-8

  {
    "url": "file:///gerrit/plugins/delete-project/delete-project-2.8.jar"
  }
```

--------------------------------

### GET /plugins/

Source: https://review.lineageos.org/Documentation/rest-api-plugins.html

Lists the plugins installed on the Gerrit server. Returns a map of plugin IDs to PluginInfo entries.

```APIDOC
## GET /plugins/

### Description
Lists the plugins installed on the Gerrit server. Only enabled plugins are returned by default.

### Method
GET

### Endpoint
/plugins/

### Parameters
#### Query Parameters
- **all** (boolean) - Optional - List all plugins including those that are disabled.
- **n** (integer) - Optional - Limit the number of plugins to be included in the results.
- **p** (string) - Optional - Limit the results to those plugins that start with the specified prefix (case sensitive).
- **r** (string) - Optional - Limit the results to those plugins that match the specified regex (case sensitive).
- **S** (integer) - Optional - Skip the given number of plugins from the beginning of the list.
- **m** (string) - Optional - Limit the results to those plugins that match the specified substring (case insensitive).

### Response
#### Success Response (200)
- **map** (object) - A map of plugin IDs to PluginInfo entries, sorted by plugin ID.
```

--------------------------------

### Install Snapshot API

Source: https://review.lineageos.org/Documentation/dev-build-plugins.html

Install a snapshot version of the plugin API into the local Maven repository when the plugin references a snapshot version.

```bash
./tools/maven/api.sh install
```

--------------------------------

### Install Gitweb Package

Source: https://review.lineageos.org/Documentation/config-gitweb.html

Commands to install the gitweb package on Ubuntu or via Yum.

```bash
  sudo apt-get install gitweb
```

```bash
  yum install gitweb
```

--------------------------------

### GET /config/server/capabilities

Source: https://review.lineageos.org/Documentation/rest-api-config.html

Lists the capabilities available in the system.

```APIDOC
## GET /config/server/capabilities

### Description
Lists the capabilities that are available in the system, including core and plugin-owned capabilities.

### Method
GET

### Endpoint
/config/server/capabilities

### Response
#### Success Response (200)
- **capabilities** (map) - A map of CapabilityInfo entities sorted by ID.
```

--------------------------------

### GET /config/server/summary

Source: https://review.lineageos.org/Documentation/rest-api-config.html

Retrieves a summary of the current server state.

```APIDOC
## GET /config/server/summary

### Description
Retrieves a summary of the current server state. Requires Administrate Server capability.

### Method
GET

### Endpoint
/config/server/summary

### Parameters
#### Query Parameters
- **jvm** (flag) - Optional - Includes a JVM summary in the response.

### Response
#### Success Response (200)
- **task_summary** (object) - Task execution summary
- **mem_summary** (object) - Memory usage summary
- **thread_summary** (object) - Thread usage summary
- **jvm_summary** (object) - JVM environment details (if requested)
```

--------------------------------

### Create a new project with description

Source: https://review.lineageos.org/Documentation/cmd-create-project.html

Initializes a new project with a description, requiring double-quoting to pass single quotes through SSH.

```bash
$ ssh -p 29418 review.example.com gerrit create-project tool.git --description "'Tools used by build system'"
```

--------------------------------

### Create Jetty startup script

Source: https://review.lineageos.org/Documentation/install-j2ee.html

Extract and prepare the init script for automatic Jetty startup.

```bash
  java -jar webapps/gerrit.war --cat extra/jetty7/gerrit-jetty.sh >/etc/init.d/gerrit-jetty
  vi /etc/init.d/gerrit-jetty
```

--------------------------------

### GET /groups/

Source: https://review.lineageos.org/Documentation/rest-api-groups.html

Queries internal groups visible to the caller based on a search query. Supports pagination via start and limit parameters.

```APIDOC
## GET /groups/

### Description
Queries internal groups visible to the caller. The query string must be provided by the query parameter.

### Method
GET

### Endpoint
/groups/?query=<query>

### Parameters
#### Query Parameters
- **query** (string) - Required - The search query string.
- **limit** (integer) - Optional - Limits the number of results returned.
- **start** (integer) - Optional - Skips the specified number of groups from the result list.

### Response
#### Success Response (200)
- **GroupInfo** (array) - A list of GroupInfo entities.
```

--------------------------------

### GET /config/server/indexes/changes/versions/{index-version}

Source: https://review.lineageos.org/Documentation/rest-api-config.html

Get info about one version of an index used by Gerrit.

```APIDOC
## GET /config/server/indexes/changes/versions/{index-version}

### Description
Get info about one version of an index used by Gerrit.

### Method
GET

### Endpoint
/config/server/indexes/changes/versions/{index-version}

### Parameters
#### Path Parameters
- **index-version** (string) - Required - The version number of the index.

### Response
#### Success Response (200)
- **is_write** (boolean) - Whether the index is written to.
- **is_search** (boolean) - Whether the index is used for search.
- **num_docs** (integer) - Number of documents in the index.
```

--------------------------------

### Run Migration in Trial Mode

Source: https://review.lineageos.org/Documentation/note-db.html

Execute the migration tool or daemon in trial mode to sync data between ReviewDb and NoteDb without fully switching storage.

```bash
java -jar gerrit.war migrate-to-note-db --trial -d /path/to/site
# OR
java -jar gerrit.war daemon -d /path/to/site --migrate-to-note-db --trial
```

--------------------------------

### GET /groups/{group-id}/log.audit

Source: https://review.lineageos.org/Documentation/rest-api-groups.html

Gets the audit log of a Gerrit internal group.

```APIDOC
## GET /groups/{group-id}/log.audit

### Description
Gets the audit log of a Gerrit internal group. Events are returned sorted by date in reverse order.

### Method
GET

### Endpoint
/groups/{group-id}/log.audit

### Parameters
#### Path Parameters
- **group-id** (string) - Required - The UUID or ID of the group.

### Response
#### Success Response (200)
- **List<GroupAuditEventInfo>** (array) - A list of audit events for the group.
```

--------------------------------

### Clean Jetty installation directory

Source: https://review.lineageos.org/Documentation/install-j2ee.html

Remove default sample webapps from a fresh Jetty installation.

```bash
  cd $JETTY_HOME
  rm -rf contexts/* webapps/*
```

--------------------------------

### Create a new project

Source: https://review.lineageos.org/Documentation/cmd-create-project.html

Initializes a new project repository on the Gerrit server via SSH.

```bash
$ ssh -p 29418 review.example.com gerrit create-project tools/gerrit.git
```

--------------------------------

### GET /accounts/{account-id}/agreements

Source: https://review.lineageos.org/Documentation/rest-api-accounts.html

Gets a list of the user’s signed contributor agreements.

```APIDOC
## GET /accounts/{account-id}/agreements

### Description
Gets a list of the user’s signed contributor agreements.

### Method
GET

### Endpoint
/accounts/{account-id}/agreements

### Parameters
#### Path Parameters
- **account-id** (string) - Required - The ID of the account.

### Response
#### Success Response (200)
- **List** (Array) - A list of ContributorAgreementInfo entities.

#### Response Example
[
  {
    "name": "Individual",
    "description": "If you are going to be contributing code on your own, this is the one you want. You can sign this one online.",
    "url": "static/cla_individual.html"
  }
]
```

--------------------------------

### Convert project reference format

Source: https://review.lineageos.org/Documentation/cmd-convert-ref-storage.html

Example command to convert the reference format of a specific project to reftable.

```bash
$ ssh -p 29418 review.example.com gerrit convert-ref-format -p core
```

--------------------------------

### Build API JAR Files

Source: https://review.lineageos.org/Documentation/dev-bazel.html

Build extension, plugin, and acceptance-framework JAR files.

```bash
  bazelisk build api
```

```bash
  bazel-bin/api.zip
```

--------------------------------

### gerrit index start

Source: https://review.lineageos.org/Documentation/cmd-index-start.html

Starts the online indexer for a specified index. Requires Administrator privileges.

```APIDOC
## gerrit index start

### Description
Starts the online indexer for a specified index. This command is useful for restarting the indexer without a full service restart.

### Usage
ssh -p <port> <host> gerrit index start <INDEX> [--force]

### Parameters
- **INDEX** (string) - Required - The index to start. Supported values: changes, accounts, groups, projects.
- **--force** (flag) - Optional - Force an online re-index.

### Access
Caller must be a member of the 'Administrators' group.

### Example
$ ssh -p 29418 review.example.com gerrit index start changes
```

--------------------------------

### Complex Query Examples

Source: https://review.lineageos.org/Documentation/user-search.html

Examples of combining multiple label operators to define complex search criteria.

```text
is:open label:Code-Review+2 label:Verified+1 NOT label:Verified-1 NOT label:Code-Review-2
```

```text
is:open label:Code-Review=ok label:Verified=ok
```

```text
is:open (label:Verified-1 OR label:Code-Review-2)
```

```text
is:open (label:Verified=reject OR label:Code-Review=reject)
```

--------------------------------

### Define and Test Prolog Predicates

Source: https://review.lineageos.org/Documentation/pgm-prolog-shell.html

Example of creating a Prolog source file and interacting with it via the shell.

```bash
	$ cat >simple.pl
	food(apple).
	food(orange).
	^D

	$ java -jar gerrit.war prolog-shell -s simple.pl
	Gerrit Code Review 2.2.1-84-ge9c3992 - Interactive Prolog Shell
	based on Prolog Cafe 1.2.5 (mantis)
	         Copyright(C) 1997-2009 M.Banbara and N.Tamura
	(type Ctrl-D or "halt." to exit, "['path/to/file.pl']." to load a file)

	{consulting /usr/local/google/users/sop/gerrit/gerrit/simple.pl ...}
	{/usr/local/google/users/sop/gerrit/gerrit/simple.pl consulted 99 msec}

	| ?- food(Type).

	Type = apple ? ;

	Type = orange ? ;

	no
	| ?-
```

--------------------------------

### Query Documentation Example

Source: https://review.lineageos.org/Documentation/rest-api-documentation.html

Generic syntax for querying documentation via the REST API.

```http
GET /Documentation/?q=keyword HTTP/1.0 
```

--------------------------------

### Group Reference Path Example

Source: https://review.lineageos.org/Documentation/config-groups.html

Example of the sharded UUID ref path used for storing group data.

```text
  refs/groups/de/deafbeefdeafbeefdeafbeefdeafbeefdeafbeef
```

--------------------------------

### Install Plugin Dependencies

Source: https://review.lineageos.org/Documentation/dev-build-plugins.html

Install required local or foreign libraries into the local Maven repository before building the plugin.

```bash
mvn install
```

--------------------------------

### Build Documentation Targets

Source: https://review.lineageos.org/Documentation/dev-bazel.html

Commands to build documentation, including options for local fonts, skipping zip archiving, and including documentation in the WAR file.

```bash
  bazelisk build Documentation:searchfree
```

```bash
  bazel-bin/Documentation/searchfree.zip
```

```bash
  bazel build Documentation:searchfree_safe
```

```bash
  bazel-bin/Documentation/searchfree.zip
  bazel-bin/Documentation/searchfree_safe.zip
```

```bash
  bazelisk build Documentation
```

```bash
  bazel-bin/Documentation/index.html
```

```bash
  bazelisk build withdocs
```

```bash
  bazel-bin/withdocs.war
```

```bash
  bazelisk build Documentation:Documentation
```

```bash
 `bazel-bin/Documentation/`
```

--------------------------------

### List System Capabilities

Source: https://review.lineageos.org/Documentation/rest-api-config.html

Returns a map of all available core and plugin-owned system capabilities.

```http
  GET /config/server/capabilities/ HTTP/1.0
```

```http
  HTTP/1.1 200 OK
  Content-Type: application/json; charset=UTF-8

  )]}'
  {
    "accessDatabase": {
      "id": "accessDatabase",
      "name": "Access Database"
    },
    "administrateServer": {
      "id": "administrateServer",
      "name": "Administrate Server"
    },
    "createAccount": {
      "id": "createAccount",
      "name": "Create Account"
    },
    "createGroup": {
      "id": "createGroup",
      "name": "Create Group"
    },
    "createProject": {
      "id": "createProject",
      "name": "Create Project"
    },
    "emailReviewers": {
      "id": "emailReviewers",
      "name": "Email Reviewers"
    },
    "flushCaches": {
      "id": "flushCaches",
      "name": "Flush Caches"
    },
    "killTask": {
      "id": "killTask",
      "name": "Kill Task"
    },
    "priority": {
      "id": "priority",
      "name": "Priority"
    },
    "queryLimit": {
      "id": "queryLimit",
      "name": "Query Limit"
    },
    "runGC": {
      "id": "runGC",
      "name": "Run Garbage Collection"
    },
    "streamEvents": {
      "id": "streamEvents",
      "name": "Stream Events"
    },
    "viewCaches": {
      "id": "viewCaches",
      "name": "View Caches"
    },
    "viewConnections": {
      "id": "viewConnections",
      "name": "View Connections"
    },
    "viewPlugins": {
      "id": "viewPlugins",
      "name": "View Plugins"
    },
    "viewQueue": {
      "id": "viewQueue",
      "name": "View Queue"
    }
  }
```

--------------------------------

### Gerrit Edit URL Examples

Source: https://review.lineageos.org/Documentation/user-inline-edit.html

Example URLs for directly accessing specific files for editing within a Gerrit repository.

```text
https://gerrit.mycompany.com/admin/repos/edit/repo/my/repo/branch/refs/heads/master/file/Jenkinsfile # Jenkins build file
https://gerrit.mycompany.com/admin/repos/edit/repo/my/repo/branch/refs/heads/master/file/catalog-info.yaml # Backstage catalog-info
```

--------------------------------

### Display release announcement script help

Source: https://review.lineageos.org/Documentation/dev-release.html

View usage instructions for the release announcement generation tool.

```bash
  ~/gerrit-release-tools/release-announcement.py --help
```

--------------------------------

### Define Access Controls in project.config

Source: https://review.lineageos.org/Documentation/config-project-config.html

Example of setting access permissions for labels, push, and submit actions.

```ini
label-Code-Review = -2..+2 group Maintainers
label-Code-Review = -1..+1 group Registered Users
label-Verified = -1..+1 group Registered Users
push = block Registered Users
submit = group Maintainers
exclusiveGroupPermissions = deleteChanges submit
[access "^refs/tags/rel-.*"]
  createTag = group Maintainers
  createSignedTag = group Maintainers
```

--------------------------------

### GET /config/server/indexes/changes

Source: https://review.lineageos.org/Documentation/rest-api-config.html

Get an index used by Gerrit, including details about index versions, search status, and write status.

```APIDOC
## GET /config/server/indexes/changes

### Description
Get an index used by Gerrit. It provides details about the index versions, which index version is used to search and which versions are written to.

### Method
GET

### Endpoint
/config/server/indexes/changes

### Response
#### Success Response (200)
- **name** (string) - The name of the index.
- **versions** (object) - Map of version numbers to their status (is_write, is_search, num_docs).
```

--------------------------------

### Inherited Project Configuration

Source: https://review.lineageos.org/Documentation/user-submodules.html

Example of a global configuration in All-Projects to allow superproject subscriptions.

```ini
    [allowSuperproject "my-only-superproject"]
        matching = refs/heads/*:refs/heads/*
```

--------------------------------

### Example Named Destination File

Source: https://review.lineageos.org/Documentation/user-named-destinations.html

A tab-delimited file format where the first column is the ref and the second is the project.

```text
# Ref            	Project
#
refs/heads/master	gerrit
refs/heads/stable-2.11	gerrit
refs/heads/master	plugins/cookbook-plugin
```

--------------------------------

### Initialize or upgrade a Gerrit server

Source: https://review.lineageos.org/Documentation/pgm-init.html

Run the Gerrit init command to create a new site or upgrade an existing one, using the specified site path and optional flags.

```bash
java -jar gerrit.war init
  -d <SITE_PATH>
  [--batch]
  [--delete-caches]
  [--no-auto-start]
  [--skip-plugins]
  [--list-plugins]
  [--install-plugin=<PLUGIN_NAME>]
  [--install-all-plugins]
  [--secure-store-lib=<PATH_TO_JAR>]
  [--dev]
  [--skip-all-downloads]
  [--skip-download=<LIBRARY_NAME>]
  [--reindex-threads=<N>]
```

--------------------------------

### Initialize Gerrit Site Directory

Source: https://review.lineageos.org/Documentation/install.html

Create a dedicated user and initialize the Gerrit site directory using the war file.

```bash
  sudo adduser gerrit
  sudo su gerrit

  java -jar gerrit.war init -d /path/to/your/gerrit_application_directory
```

--------------------------------

### gerrit plugin install

Source: https://review.lineageos.org/Documentation/cmd-plugin-install.html

Installs or adds a plugin to the site's plugins directory. Requires Administrator privileges and specific configuration settings.

```APIDOC
## gerrit plugin install | add

### Description
Installs or adds a plugin to the site path's plugins directory. The command supports installation via URL, local file path, or piped input.

### Usage
ssh -p <port> <host> gerrit plugin install | add [--name <NAME> | -n <NAME>] - | <URL> | <PATH>

### Options
- **--name / -n** (string) - Optional - The name under which the plugin should be installed. If the plugin provides its own name in the MANIFEST file, the MANIFEST name takes precedence.
- **-** (input) - Optional - Plugin jar or js as piped input.
- **<URL>** (string) - Optional - URL from where the plugin should be downloaded (HTTP or FTP).
- **<PATH>** (string) - Optional - Absolute file path to the plugin jar or js.

### Access Requirements
- Caller must be a member of the 'Administrators' group.
- plugins.allowRemoteAdmin must be enabled in $site_path/etc/gerrit.config.
```

--------------------------------

### Configure Gitweb Settings

Source: https://review.lineageos.org/Documentation/config-gitweb.html

Example configuration for /etc/gitweb.conf to define repository paths and UI assets.

```perl
$projectroot = "/var/www/repo/";

# directory to use for temp files
$git_temp = "/tmp";

# target of the home link on top of all pages
#$home_link = $my_uri || "/";

# html text to include at home page
$home_text = "indextext.html";

# file with project list; by default, simply scan the projectroot dir.
$projects_list = $projectroot;

# stylesheet to use
# I took off the prefix / of the following path to put these files inside gitweb directory directly
$stylesheet = "gitweb.css";

# logo to use
$logo = "git-logo.png";

# the favicon
$favicon = "git-favicon.png";
```

--------------------------------

### GET /config/server/caches/

Source: https://review.lineageos.org/Documentation/rest-api-config.html

Lists the caches of the server.

```APIDOC
## GET /config/server/caches/

### Description
Lists the caches of the server. Caches defined by plugins are included. The caller must be a member of a group that is granted one of the following capabilities: View Caches, Maintain Server, or Administrate Server.

### Method
GET

### Endpoint
/config/server/caches/

### Response
#### Success Response (200)
- **caches** (map) - A map of CacheInfo entities sorted by cache name.
```

--------------------------------

### Get Account

Source: https://review.lineageos.org/Documentation/rest-api-accounts.html

Retrieves an account entity by its ID.

```http
  GET /accounts/self HTTP/1.0
```

```http
  HTTP/1.1 200 OK
  Content-Disposition: attachment
  Content-Type: application/json; charset=UTF-8

  )]}'
  {
    "_account_id": 1000096,
    "name": "John Doe",
    "email": "john.doe@example.com",
    "username": "john"
    "display_name": "Super John"
  }
```

--------------------------------

### Define local mirrors in local.properties

Source: https://review.lineageos.org/Documentation/dev-bazel.html

Redirect dependency downloads to local mirrors by appending configuration to the local.properties file.

```bash
  echo download.GERRIT = http://nexus.my-company.com/ >>local.properties
  echo download.MAVEN_CENTRAL = http://nexus.my-company.com/ >>local.properties
```

--------------------------------

### Get Subgroup

Source: https://review.lineageos.org/Documentation/rest-api-groups.html

Retrieves details of a specific subgroup.

```HTTP
  GET /groups/834ec36dd5e0ed21a2ff5d7e2255da082d63bbd7/groups/7ca042f4d5847936fcb90ca91057673157fd06fc HTTP/1.0
```

```HTTP
  HTTP/1.1 200 OK
  Content-Disposition: attachment
  Content-Type: application/json; charset=UTF-8

  )]}'
  {
    "id": "7ca042f4d5847936fcb90ca91057673157fd06fc",
    "name": "MyProject-Verifiers",
    "url": "#/admin/groups/uuid-7ca042f4d5847936fcb90ca91057673157fd06fc",
    "options": {
    },
    "group_id": 38,
    "owner": "Administrators",
    "owner_id": "6a1e70e1a88782771a91808c8af9bbb7a9871389",
    "created_on": "2013-02-01 09:59:32.126000000"
  }
```

--------------------------------

### Configure branch patterns for labels and requirements

Source: https://review.lineageos.org/Documentation/config-submit-requirements

Shows how to use regular expressions for branch matching in labels and submit requirements.

```ini
[label "Verified"]
  branch = refs/heads/release/*
```

```ini
[submit-requirement "Verified"]
  submittableIf = label:Verified=MAX AND -label:Verified=MIN
  applicableIf = branch:^refs/heads/release/.*
```

--------------------------------

### Get Group Options

Source: https://review.lineageos.org/Documentation/rest-api-groups.html

Retrieves the options of a group.

```http
  GET /groups/9999c971bb4ab872aab759d8c49833ee6b9ff320/options HTTP/1.0
```

```http
  HTTP/1.1 200 OK
  Content-Disposition: attachment
  Content-Type: application/json; charset=UTF-8

  )]}'
  {
    "visible_to_all": true
  }
```

--------------------------------

### Clone the RecipeBook repository

Source: https://review.lineageos.org/Documentation/intro-gerrit-walkthrough.html

Initializes a local copy of the project from the Gerrit server.

```bash
git clone ssh://gerrithost:29418/RecipeBook.git RecipeBook
```

--------------------------------

### Get Group Name

Source: https://review.lineageos.org/Documentation/rest-api-groups.html

Retrieves the name of a group.

```http
  GET /groups/9999c971bb4ab872aab759d8c49833ee6b9ff320/name HTTP/1.0
```

```http
  HTTP/1.1 200 OK
  Content-Disposition: attachment
  Content-Type: application/json; charset=UTF-8

  )]}'
  "MyProject-Committers"
```

--------------------------------

### Fetch project dependencies

Source: https://review.lineageos.org/Documentation/dev-bazel.html

Download all required dependency JARs upfront to enable offline builds.

```bash
  bazelisk fetch //...
```

--------------------------------

### Run ChangeExternalIdCaseSensitivity Tool

Source: https://review.lineageos.org/Documentation/pgm-ChangeExternalIdCaseSensitivity.html

Basic command syntax for executing the migration tool.

```bash
_java_ -jar gerrit.war _ChangeExternalIdCaseSensitivity_
  -d <SITE_PATH>
  [--batch]
  [--dryrun]
```

--------------------------------

### plugin.getPluginName()

Source: https://review.lineageos.org/Documentation/pg-plugin-dev.html

Returns the name this plugin was installed as by the server administrator.

```APIDOC
### plugin.getPluginName()

Returns the name this plugin was installed as by the server administrator.
```

--------------------------------

### Example Output of show-caches

Source: https://review.lineageos.org/Documentation/cmd-show-caches.html

Displays the tabular output format for cache entries and system resource usage.

```text
$ ssh -p 29418 review.example.com gerrit show-caches
Gerrit Code Review        2.9                       now   11:14:13   CEST
                                                 uptime    6 days 20 hrs
  Name                          |Entries              |  AvgGet |Hit Ratio|
                                |   Mem   Disk   Space|         |Mem  Disk|
--------------------------------+---------------------+---------+---------
  accounts                      |  4096               |   3.4ms | 99%     |
  adv_bases                     |                     |         |         |
  changes                       |                     |  27.1ms |  0%     |
  groups                        |  5646               |  11.8ms | 97%     |
  groups_bymember               |                     |         |         |
  groups_byname                 |                     |         |         |
  groups_bysubgroup             |   230               |   2.4ms | 62%     |
  groups_byuuid                 |  5612               |  29.2ms | 99%     |
  groups_external               |     1               |   1.5s  | 98%     |
  ldap_group_existence          |                     |         |         |
  ldap_groups                   |   650               | 680.5ms | 99%     |
  ldap_groups_byinclude         |  1024               |         | 83%     |
  ldap_usernames                |   390               |   3.8ms | 81%     |
  permission_sort               | 16384               |         | 99%     |
  plugin_resources              |                     |         |         |
  project_list                  |     1               |   3.8s  | 99%     |
  projects                      |  6477               |   2.9ms | 99%     |
  sshkeys                       |  2048               |  12.5ms | 99%     |
D diff                          |  1299  62033 132.36m|  22.0ms | 85%  99%|
D diff_intraline                | 12777 218651 128.45m| 171.1ms | 31%  96%|
D git_tags                      |     3      6  11.85k|         |  0% 100%|
D web_sessions                  |  1024 151714  59.10m|         | 99%  57%|

SSH:    385  users, oldest session started    6 days 20 hrs ago
Tasks:   10  total =    6 running +      0 ready +    4 sleeping
Mem:  14.94g total =   3.04g used +  11.89g free +  10.00m buffers
      28.44g max
         107 open files

Threads: 4 CPUs available, 371 threads
```

--------------------------------

### GET /accounts/{account-id}/active

Source: https://review.lineageos.org/Documentation/rest-api-accounts.html

Checks if an account is active.

```APIDOC
## GET /accounts/{account-id}/active

### Description
Checks if an account is active. If the account is active, 'ok' is returned. If inactive, 204 No Content is returned.

### Method
GET

### Endpoint
/accounts/{account-id}/active

### Parameters
#### Path Parameters
- **account-id** (string) - Required - The ID of the account.

### Response
#### Success Response (200)
- **status** (string) - 'ok'

#### Success Response (204)
- No Content (if inactive)
```

--------------------------------

### GET /accounts/{account-id}/username

Source: https://review.lineageos.org/Documentation/rest-api-accounts.html

Retrieves the username of an account.

```APIDOC
## GET /accounts/{account-id}/username

### Description
Retrieves the username of an account. If the account does not have a username, the response is 404 Not Found.

### Method
GET

### Endpoint
/accounts/{account-id}/username

### Parameters
#### Path Parameters
- **account-id** (string) - Required - The ID of the account.

### Response
#### Success Response (200)
- **username** (string) - The username of the account.
```

--------------------------------

### Start Online Migration via CLI

Source: https://review.lineageos.org/Documentation/note-db.html

Initiate the online migration process by passing the migration flag to the gerrit.war daemon command.

```bash
java -jar gerrit.war daemon -d /path/to/site --migrate-to-note-db
```

--------------------------------

### GET /accounts/{account-id}/status

Source: https://review.lineageos.org/Documentation/rest-api-accounts.html

Retrieves the status of an account.

```APIDOC
## GET /accounts/{account-id}/status

### Description
Retrieves the status of an account. If the account does not have a status, an empty string is returned.

### Method
GET

### Endpoint
/accounts/{account-id}/status

### Parameters
#### Path Parameters
- **account-id** (string) - Required - The ID of the account.

### Response
#### Success Response (200)
- **status** (string) - The status of the account.

#### Response Example
"Available"
```

--------------------------------

### Example output of gerrit show-queue

Source: https://review.lineageos.org/Documentation/cmd-show-queue.html

Sample output showing tasks scheduled for project replication.

```text
$ ssh -p 29418 review.example.com gerrit show-queue
Task     State                 Command
------------------------------------------------------------------------------
7aae09b2 14:31:15.435          mirror dst1:/home/git/tools/gerrit.git
9ad09d27 14:31:25.434          mirror dst2:/var/cache/tools/gerrit.git
------------------------------------------------------------------------------
2 tasks
```

--------------------------------

### GET /accounts/{account-id}

Source: https://review.lineageos.org/Documentation/rest-api-accounts.html

Returns an account as an AccountInfo entity.

```APIDOC
## GET /accounts/{account-id}

### Description
Returns an account as an AccountInfo entity.

### Method
GET

### Endpoint
/accounts/{account-id}

### Parameters
#### Path Parameters
- **account-id** (string) - Required - The ID of the account or 'self'.
```

--------------------------------

### MigrateAccountPatchReviewDb Synopsis

Source: https://review.lineageos.org/Documentation/pgm-MigrateAccountPatchReviewDb.html

The basic command structure for executing the migration tool.

```bash
_java_ -jar gerrit.war MigrateAccountPatchReviewDb
  -d <SITE_PATH>
  [--sourceUrl] [--chunkSize]
```

--------------------------------

### GET /config/server/indexes/changes/versions

Source: https://review.lineageos.org/Documentation/rest-api-config.html

Lists versions of an index used by Gerrit.

```APIDOC
## GET /config/server/indexes/changes/versions

### Description
Lists versions of an index used by Gerrit.

### Method
GET

### Endpoint
/config/server/indexes/changes/versions

### Response
#### Success Response (200)
- **versions** (object) - Map of version numbers to their status (is_write, is_search, num_docs).
```

--------------------------------

### GET /config/server/indexes

Source: https://review.lineageos.org/Documentation/rest-api-config.html

Lists the indexes used by Gerrit and their status.

```APIDOC
## GET /config/server/indexes

### Description
Lists the indexes used by Gerrit, including version details, search status, and write status. Requires the Maintain Server capability.

### Method
GET

### Endpoint
/config/server/indexes/

### Response
#### Success Response (200)
- **Array** (object) - List of index objects containing name and version details.
```
Tokens:
Raw