Commit 3d1aff87 authored by Lukas Eipert's avatar Lukas Eipert

Clarify search parameter in the branches API docs

parent 14397584
...@@ -18,11 +18,10 @@ GET /projects/:id/repository/branches ...@@ -18,11 +18,10 @@ GET /projects/:id/repository/branches
Parameters: Parameters:
| Attribute | Type | Required | Description | | 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. | | `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. | | `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: Example request:
```sh ```sh
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment