diff options
| author | Rémy Coutable <remy@rymai.me> | 2016-10-21 11:12:33 +0000 |
|---|---|---|
| committer | Rémy Coutable <remy@rymai.me> | 2016-10-21 11:12:33 +0000 |
| commit | 257789e9b79254e841e79ed91969f08647744cbc (patch) | |
| tree | f95875995ca9399653c0885bebbe767719c84b15 | |
| parent | 60adbef4afb864bf5a19ce6e39dd8fe02ac99c0a (diff) | |
| parent | dab95689a3f267e6ee4e4fa9da304a01d37a5a4e (diff) | |
| download | gitlab-ce-257789e9b79254e841e79ed91969f08647744cbc.tar.gz | |
Merge branch 'patch-1' into 'master'
[Doc] Fix `ref` parameter name for `commits/statuses`
The attribute to filter by branch or tag needs to be named `ref`, not `ref_name`. And indeed the attribute in the JSON response is `ref` (and not `ref_name`).
Tested on Gitlab CE 8.9.
See merge request !4876
| -rw-r--r-- | doc/api/commits.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/api/commits.md b/doc/api/commits.md index 6e0882a94de..e1ed99d98d3 100644 --- a/doc/api/commits.md +++ b/doc/api/commits.md @@ -319,7 +319,7 @@ GET /projects/:id/repository/commits/:sha/statuses | --------- | ---- | -------- | ----------- | | `id` | integer/string | yes | The ID of a project or NAMESPACE/PROJECT_NAME owned by the authenticated user | `sha` | string | yes | The commit SHA -| `ref_name`| string | no | The name of a repository branch or tag or, if not given, the default branch +| `ref` | string | no | The name of a repository branch or tag or, if not given, the default branch | `stage` | string | no | Filter by [build stage](../ci/yaml/README.md#stages), e.g., `test` | `name` | string | no | Filter by [job name](../ci/yaml/README.md#jobs), e.g., `bundler:audit` | `all` | boolean | no | Return all statuses, not only the latest ones |