@PLUGIN@ - /projects/ REST API

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

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

Importer Endpoints

Copy Project

PUT /projects/{project-name}/@PLUGIN@~copy

Copies a project.

Information about the copy target must be provided in the request body as a CopyProjectInput entity.

Caller must be a member of a group that is granted the ‘CopyProject’ capability (provided by this plugin) or the ‘Administrate Server’ capability.

Request

  PUT /projects/myProject/@PLUGIN@~copy HTTP/1.0
  Content-Type: application/json;charset=UTF-8

  {
    "name": "myProjectCopy"
  }

Resume Copy Project

PUT /projects/{project-name}/@PLUGIN@~copy.resume

Resumes copying to a project from the original copy source.

Caller must be a member of a group that is granted the ‘CopyProject’ capability (provided by this plugin) or the ‘Administrate Server’ capability.

Request

  PUT /projects/myProjectCopy/@PLUGIN@~copy.resume HTTP/1.0

Resume Project Import

PUT /projects/{project-name}/@PLUGIN@~import.resume

Resumes importing to a project from the original copy source.

Information about the import resume must be provided in the request body as a ImportResumeInput entity.

Caller must be a member of a group that is granted the ‘ImportProject’ capability (provided by this plugin) or the ‘Administrate Server’ capability.

Request

  PUT /projects/myProjectCopy/@PLUGIN@~import.resume HTTP/1.0
  Content-Type: application/json;charset=UTF-8

  {
    "user": "myUser",
    "pass": "myPassword"
  }

JSON Entities

CopyProjectInput

The CopyProjectInput entity contains information about a the copy target.

  • name: The target project name.

SEE ALSO

GERRIT

Part of Gerrit Code Review