Merge branch 'jej-update-mr-state-event-docs' into 'master'
Update MergeRequest API state_event option documentation Closes #25566 See merge request !8077
This commit is contained in:
commit
199b17e556
2 changed files with 6 additions and 5 deletions
|
@ -350,16 +350,17 @@ PUT /projects/:id/merge_requests/:merge_request_id
|
|||
| --------- | ---- | -------- | ----------- |
|
||||
| `id` | string | yes | The ID of a project |
|
||||
| `merge_request_id` | integer | yes | The ID of a merge request |
|
||||
| `source_branch` | string | yes | The source branch |
|
||||
| `target_branch` | string | yes | The target branch |
|
||||
| `title` | string | yes | Title of MR |
|
||||
| `target_branch` | string | no | The target branch |
|
||||
| `title` | string | no | Title of MR |
|
||||
| `assignee_id` | integer | no | Assignee user ID |
|
||||
| `description` | string | no | Description of MR |
|
||||
| `target_project_id` | integer | no | The target project (numeric id) |
|
||||
| `state_event` | string | no | New state (close/reopen) |
|
||||
| `labels` | string | no | Labels for MR as a comma-separated list |
|
||||
| `milestone_id` | integer | no | The ID of a milestone |
|
||||
| `remove_source_branch` | boolean | no | Flag indicating if a merge request should remove the source branch when merging |
|
||||
|
||||
Must include at least one non-required attribute from above.
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
|
|
|
@ -138,7 +138,7 @@ module API
|
|||
params do
|
||||
optional :title, type: String, allow_blank: false, desc: 'The title of the merge request'
|
||||
optional :target_branch, type: String, allow_blank: false, desc: 'The target branch'
|
||||
optional :state_event, type: String, values: %w[close reopen merge],
|
||||
optional :state_event, type: String, values: %w[close reopen],
|
||||
desc: 'Status of the merge request'
|
||||
use :optional_params
|
||||
at_least_one_of :title, :target_branch, :description, :assignee_id,
|
||||
|
|
Loading…
Reference in a new issue