diff options
| author | Lukas Eipert <leipert@gitlab.com> | 2019-01-27 23:36:23 +0300 |
|---|---|---|
| committer | Lukas Eipert <leipert@gitlab.com> | 2019-01-30 17:37:55 +0300 |
| commit | 3d1aff8796682c83f4f47b2657b9e5f424af2d0a (patch) | |
| tree | 46ee2af7a062c9b44bcbe51bfa1cbfb8e9622703 /doc/api/branches.md | |
| parent | 143975841cc47ce775e6b0d8c58517953cfc92fa (diff) | |
Clarify search parameter in the branches API docs
Diffstat (limited to 'doc/api/branches.md')
| -rw-r--r-- | doc/api/branches.md | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/doc/api/branches.md b/doc/api/branches.md index 8d5f333ba77..62468b6e917 100644 --- a/doc/api/branches.md +++ b/doc/api/branches.md @@ -18,11 +18,10 @@ GET /projects/:id/repository/branches Parameters: -| Attribute | Type | Required | Description | -|:----------|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | -| `search` | string | no | Return list of branches matching the search criteria. | - +| Attribute | Type | Required | Description | +|:----------|:---------------|:---------|:------------| +| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user.| +| `search` | string | no | Return list of branches containing the search string. You can use `^term` and `term$` to find branches that begin and end with `term` respectively.| Example request: ```sh |