diff options
| author | Achilleas Pipinellis <axil@gitlab.com> | 2019-02-08 14:49:25 +0000 |
|---|---|---|
| committer | Achilleas Pipinellis <axil@gitlab.com> | 2019-02-08 14:49:25 +0000 |
| commit | c397cf67c12a3623264237d48afb2d43b6e4ab11 (patch) | |
| tree | 1eb9da3cd4443d180a84590948a32a0f7b6e2d2e | |
| parent | 2cbf33d2f1c010ce8a01ec4bf6e11c7e26667620 (diff) | |
| parent | 3d1aff8796682c83f4f47b2657b9e5f424af2d0a (diff) | |
| download | gitlab-ce-c397cf67c12a3623264237d48afb2d43b6e4ab11.tar.gz | |
Merge branch 'docs-branches-api-search' into 'master'
Clarify search parameter in the branches API docs
See merge request gitlab-org/gitlab-ce!24703
| -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 |