diff options
| author | Sean McGivern <sean@mcgivern.me.uk> | 2017-02-10 12:33:38 +0000 |
|---|---|---|
| committer | Sean McGivern <sean@mcgivern.me.uk> | 2017-02-10 12:33:38 +0000 |
| commit | 199b17e5569015bf76ddd9364fc555a3a385c564 (patch) | |
| tree | 34912b19392fdec6b12c06aaae04d722a59e3836 | |
| parent | de65731631c741db65cf6e6297715c936a7aaf10 (diff) | |
| parent | 744df2dca8528a61e47091b2d153f087565f342c (diff) | |
| download | gitlab-ce-199b17e5569015bf76ddd9364fc555a3a385c564.tar.gz | |
Merge branch 'jej-update-mr-state-event-docs' into 'master'
Update MergeRequest API state_event option documentation
Closes #25566
See merge request !8077
| -rw-r--r-- | doc/api/merge_requests.md | 9 | ||||
| -rw-r--r-- | lib/api/merge_requests.rb | 2 |
2 files changed, 6 insertions, 5 deletions
diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index 1cf7632d60c..6ee377125d6 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -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, diff --git a/lib/api/merge_requests.rb b/lib/api/merge_requests.rb index 782147883c8..8e09a6f7354 100644 --- a/lib/api/merge_requests.rb +++ b/lib/api/merge_requests.rb @@ -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, |