Clarify search parameter in the branches API docs

3d1aff87 · Lukas Eipert · 14397584 · 3d1aff87
Commit 3d1aff87 authored Jan 27, 2019 by Lukas Eipert
Hide whitespace changes
Inline Side-by-side

Showing with 4 additions and 5 deletions

doc/api/branches.md doc/api/branches.md +4 -5

No files found.
--- 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