src/main/resources/Documentation/rest-api-projects.md

@PLUGIN@ - /project/ REST API
===================+=========

This page describes the '/project/' REST endpoints that are added by
the @PLUGIN@ plugin.

Please also take note of the general information on the
[REST API](../../../Documentation/rest-api.html).

<a id="project-endpoints"> @PLUGIN@ Endpoints
---------------------------------------------

### <a id="upload-image"> Upload Image
_POST /project/[\{project-name\}](../../../Documentation/rest-api-projects.html#project-name)/@PLUGIN@~images_

Uploads an image.

The image must be specified in the request body as a
[ImageInput](#image-input) entity.

Caller must have the
[Create Reference](../../../Documentation/access-control.html#category_create)
access right on the `refs/images/*` namespace of the project.

Only available if [image server is enabled](config.md#enable-image-server).

#### Request

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

  {
    "image_data": "data:image/png;base64,iVBORw0KGgoAAAAN..."
  }
```

#### Response

```
  HTTP/1.1 201 Created
```

### <a id="delete-image"> Delete Image
_DELETE /project/[\{project-name\}](../../../Documentation/rest-api-projects.html#project-name)/@PLUGIN@~images/[\{image-ref\}](#image-ref)_

Deletes an image.

Caller must have the
[Force Push](../../../Documentation/access-control.html#category_push)
access right on the `refs/images/*` namespace of the project or be
granted the `Delete Own Images` global capability which allows deleting
own images.

Only available if [image server is enabled](config.md#enable-image-server).

#### Request

```
  DELETE /config/server/@PLUGIN@~images/refs%2Fimages%2Fec%2F3b946dcbcc5dfae0e127656168ab6dc55bbda8 HTTP/1.0
```

#### Response

```
  HTTP/1.1 204 No Content
```

<a id="ids">IDs
---------------

### <a id="image-ref"></a>Image Ref

The `refs/images/` ref, must be URL encoded.
E.g. `refs%2Fimages%2Fec%2F3b946dcbcc5dfae0e127656168ab6dc55bbda8`.

<a id="json-entities">JSON Entities
-----------------------------------

### <a id="image-input"></a>ImageInput

The `ImageInput` entity contains the image that should be uploaded.

* _file\_name_: The name of the image file (optional).
* _image\_data_: The image data URL.

SEE ALSO
--------

* [Project related REST endpoints](../../../Documentation/rest-api-project.html)

GERRIT
------
Part of [Gerrit Code Review](../../../Documentation/index.html)