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.
GET /config/server/@PLUGIN@~config
Gets the configuration of the @PLUGIN@ plugin.
GET /config/server/@PLUGIN@~config HTTP/1.0
As response a ConfigInfo entity is returned that contains the configuration of the @PLUGIN@ plugin.
HTTP/1.1 200 OK
Content-Disposition: attachment
Content-Type: application/json;charset=UTF-8
)]}'
{
"show_jobs_panel": true,
"show_jobs_drop_down_panel": false
}
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.
PUT /config/server/@PLUGIN@~config HTTP/1.0
Content-Type: application/json;charset=UTF-8
{
"show_jobs_panel": true,
"show_jobs_drop_down_panel": false
}
The ConfigInfo entity contains the configuration of the @PLUGIN@ plugin.
| Field Name | Description |
|---|---|
| show_jobs_panel | Whether jobs panel should be displayed |
| show_jobs_drop_down_panel | Whether jobs drop down panel should be displayed |
| show_jobs_summary_panel | Whether jobs summary panel should be displayed |
| show_jobs_below_related_info_block | Whether jobs panel should be positioned below related info block |
| enable_in_progress_status | Whether value=2 should be treated as ‘in progress’ status |
| sort_jobs_panel | The order of jobs sorting on jobs panel (REPORTER,NAME,DATE) |
| sort_jobs_drop_down_panel | The order of jobs sorting on jobs drop down panel (REPORTER,NAME,DATE) |
Part of Gerrit Code Review