Commit 2030120b authored by Marcia Ramos's avatar Marcia Ramos

Merge branch 'kerrizor/update-merge-request-api-docs-to-include-overflow-element' into 'master'

Update merge request api docs to reflect changes to /changes endpoint

See merge request gitlab-org/gitlab!47555
parents d1f300cb f385b7f5
...@@ -787,10 +787,17 @@ Shows information about the merge request including its files and changes. ...@@ -787,10 +787,17 @@ Shows information about the merge request including its files and changes.
GET /projects/:id/merge_requests/:merge_request_iid/changes GET /projects/:id/merge_requests/:merge_request_iid/changes
``` ```
[Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/46190) in GitLab 13.6,
diffs associated with the set of changes will have the same size limitations applied as other diffs
returned by the API or viewed via the UI. When these limits impact the results, the `overflow`
field will contain a value of `true`. Diff data without these limits applied can be retrieved by
adding the `access_raw_diffs` parameter, however, it will be slower and more resource-intensive.
Parameters: Parameters:
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user - `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user.
- `merge_request_iid` (required) - The internal ID of the merge request - `merge_request_iid` (required) - The internal ID of the merge request.
- `access_raw_diffs` (optional) - Retrieve change diffs without size limitations.
```json ```json
{ {
...@@ -884,7 +891,8 @@ Parameters: ...@@ -884,7 +891,8 @@ Parameters:
"renamed_file": false, "renamed_file": false,
"deleted_file": false "deleted_file": false
} }
] ],
"overflow": false
} }
``` ```
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment