@PLUGIN@ - /config/ REST API

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

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

@PLUGIN@ Endpoints

Get Config

GET /config/server/@PLUGIN@~config

Gets the configuration of the @PLUGIN@ plugin.

Request

  GET /config/server/@PLUGIN@~config HTTP/1.0

As response a ConfigInfo entity is returned that contains the configuration of the @PLUGIN@ plugin.

Response

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

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

Put Config

PUT /config/server/@PLUGIN@~config

Sets the configuration of the @PLUGIN@ plugin.

The new configuration must be specified as a ConfigInfo entity in the request body. Not setting a parameter leaves the parameter unchanged.

Request

  PUT /config/server/@PLUGIN@~config HTTP/1.0
  Content-Type: application/json;charset=UTF-8

  {
    "default_project": "All-Images"
  }

JSON Entities

ConfigInfo

The ConfigInfo 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.
  • enable_image_server: Whether Gerrit is used as image server.
  • pattern: JavaScript Regular expression to match URLs of images that should be embedded.
  • upload_url: URL to upload images.

SEE ALSO

GERRIT

Part of Gerrit Code Review