diff options
| author | Rémy Coutable <remy@rymai.me> | 2018-07-30 08:54:49 +0000 |
|---|---|---|
| committer | Rémy Coutable <remy@rymai.me> | 2018-07-30 08:54:49 +0000 |
| commit | 2ca8219a20f16636b7a0ffa899a1a04ab8e84782 (patch) | |
| tree | b637dbc46b77a247e0618317a215f94d595cb83f | |
| parent | 87f03f01735fb4b6dbef2e4bf625cf2546523a4e (diff) | |
| parent | 59fdc168dcaaa7135bdf430691fd89e45a6a713c (diff) | |
| download | gitlab-ce-2ca8219a20f16636b7a0ffa899a1a04ab8e84782.tar.gz | |
Merge branch '47728-mr-api-documentation-changes' into 'master'
Resolve "Merge Request API response is missing changes_count"
Closes #47728
See merge request gitlab-org/gitlab-ce!19745
| -rw-r--r-- | changelogs/unreleased/47728-mr-api-documentation-changes.yml | 5 | ||||
| -rw-r--r-- | doc/api/merge_requests.md | 17 |
2 files changed, 10 insertions, 12 deletions
diff --git a/changelogs/unreleased/47728-mr-api-documentation-changes.yml b/changelogs/unreleased/47728-mr-api-documentation-changes.yml new file mode 100644 index 00000000000..12720f280a1 --- /dev/null +++ b/changelogs/unreleased/47728-mr-api-documentation-changes.yml @@ -0,0 +1,5 @@ +--- +title: Remove changes_count from MR API documentation where necessary +merge_request: 19745 +author: Jan Beckmann +type: fixed diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index 34c2dd7b34d..58d05a70d05 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -15,11 +15,6 @@ given state (`opened`, `closed`, `locked`, or `merged`) or all of them (`all`). The pagination parameters `page` and `per_page` can be used to restrict the list of merge requests. -**Note**: the `changes_count` value in the response is a string, not an -integer. This is because when an MR has too many changes to display and store, -it will be capped at 1,000. In that case, the API will return the string -`"1000+"` for the changes count. - ``` GET /merge_requests GET /merge_requests?state=opened @@ -104,7 +99,6 @@ Parameters: "sha": "8888888888888888888888888888888888888888", "merge_commit_sha": null, "user_notes_count": 1, - "changes_count": "1", "should_remove_source_branch": true, "force_remove_source_branch": false, "squash": false, @@ -144,10 +138,6 @@ will be the same. In the case of a merge request from a fork, `target_project_id` and `project_id` will be the same and `source_project_id` will be the fork project's ID. -**Note**: the `changes_count` value in the response is a string, not an -integer. This is because when an MR has too many changes to display and store, -it will be capped at 1,000. In that case, the API will return the string -`"1000+"` for the changes count. Parameters: @@ -224,7 +214,6 @@ Parameters: "sha": "8888888888888888888888888888888888888888", "merge_commit_sha": null, "user_notes_count": 1, - "changes_count": "1", "should_remove_source_branch": true, "force_remove_source_branch": false, "squash": false, @@ -331,7 +320,6 @@ Parameters: "sha": "8888888888888888888888888888888888888888", "merge_commit_sha": null, "user_notes_count": 1, - "changes_count": "1", "should_remove_source_branch": true, "force_remove_source_branch": false, "web_url": "http://example.com/example/example/merge_requests/1", @@ -350,6 +338,11 @@ Parameters: Shows information about a single merge request. +**Note**: the `changes_count` value in the response is a string, not an +integer. This is because when an MR has too many changes to display and store, +it will be capped at 1,000. In that case, the API will return the string +`"1000+"` for the changes count. + ``` GET /projects/:id/merge_requests/:merge_request_iid ``` |