diff options
author | Pierre de La Morinerie <pmorinerie@captaintrain.com> | 2016-06-23 13:07:51 +0000 |
---|---|---|
committer | Pierre de La Morinerie <pmorinerie@captaintrain.com> | 2016-06-23 13:07:51 +0000 |
commit | dab95689a3f267e6ee4e4fa9da304a01d37a5a4e (patch) | |
tree | ba8a7ea821494a5a234e6bbc38c7ab2658cc48e9 /doc/api | |
parent | 2de9d66fe44fd98e6ba1264058c642d05a33f2e8 (diff) | |
download | gitlab-ce-dab95689a3f267e6ee4e4fa9da304a01d37a5a4e.tar.gz |
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.
Diffstat (limited to 'doc/api')
-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 57c2e1d9b87..d1317e5cc07 100644 --- a/doc/api/commits.md +++ b/doc/api/commits.md @@ -229,7 +229,7 @@ GET /projects/:id/repository/commits/:sha/statuses | --------- | ---- | -------- | ----------- | | `id` | integer | yes | The ID of a project | `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 |