summaryrefslogtreecommitdiff
path: root/doc/api/branches.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/branches.md')
-rw-r--r--doc/api/branches.md9
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