@PLUGIN@ - /accounts/ REST API

This page describes the ‘/accounts/’ REST endpoints that are added by the @PLUGIN@ plugin.

Please also take note of the general information on the REST API.

@PLUGIN@ Endpoints

Get Preferences

GET /accounts/{account-id}/@PLUGIN@~preference

Gets the preferences of a user for the @PLUGIN@ plugin.

Request

  GET /accounts/self/@PLUGIN@~preference HTTP/1.0

As response a PreferenceInfo entity is returned that contains the preferences of a user for the @PLUGIN@ plugin.

Response

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

  )]}'
  {
    "default_project": "All-Images",
    "link_decoration": "INLINE",
    "enable\_image_server": true
  }

Put Preferences

PUT /accounts/{account-id}/@PLUGIN@~preference

Sets the configuration of the @PLUGIN@ plugin.

The new preferences must be specified as a PreferenceInfo entity in the request body. Not setting a parameter means that the parameter is unset and that the global setting for this parameter applies again.

Request

  PUT /accounts/self/@PLUGIN@~preference HTTP/1.0
  Content-Type: application/json;charset=UTF-8

  {
    "default_project": "All-Images"
  }

JSON Entities

PreferenceInfo

The PreferenceInfo entity contains the configuration of the @PLUGIN@ plugin.

  • default_project: The project to which images should be uploaded by default.
  • link_decoration: Decoration for image links in the Gerrit WebUI. NONE: no decoration, TOOLTIP: the image is shown as tooltip on mouse over an image link, INLINE: the image is inlined instead of the URL.
  • stage: Whether images should be staged before upload.
  • pattern: JavaScript Regular expression to match URLs of images that should be embedded (read-only).

SEE ALSO

GERRIT

Part of Gerrit Code Review