summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorZeger-Jan van de Weg <mail@zjvandeweg.nl>2015-12-16 21:39:27 +0100
committerZeger-Jan van de Weg <mail@zjvandeweg.nl>2015-12-16 21:46:00 +0100
commitc36821df9f571855b477b09c102b90a78b9079e9 (patch)
treeb875e23256410e33d60a42f306f8964661400860 /doc/api
parenta9f7df56ba53e1bf51355c08a70b4e82bc4d7f7d (diff)
downloadgitlab-ce-c36821df9f571855b477b09c102b90a78b9079e9.tar.gz
Api support for requesting starred projects for user
Fixes #4112
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/projects.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md
index 2c7a3d5c552..658e65c6f01 100644
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@@ -139,6 +139,21 @@ Parameters:
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
- `search` (optional) - Return list of authorized projects according to a search criteria
+### List starred projects
+
+Get a list of projects which are starred by the authenticated user.
+
+```
+GET /projects/starred
+```
+
+Parameters:
+
+- `archived` (optional) - if passed, limit by archived status
+- `order_by` (optional) - Return requests ordered by `id`, `name`, `path`, `created_at`, `updated_at` or `last_activity_at` fields. Default is `created_at`
+- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
+- `search` (optional) - Return list of authorized projects according to a search criteria
+
### List ALL projects
Get a list of all GitLab projects (admin only).