summaryrefslogtreecommitdiff
path: root/doc/api/projects.md
diff options
context:
space:
mode:
authorDmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>2015-12-16 22:49:28 +0000
committerDmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>2015-12-16 22:49:28 +0000
commit9ede66f619bb030ad351a7abf7b1be2148de7f99 (patch)
tree91ea3217593e7b654eb620dd9dd9715e9f312272 /doc/api/projects.md
parenta9b078535b870e52c113f2a624fc3518b4f6b208 (diff)
parentc36821df9f571855b477b09c102b90a78b9079e9 (diff)
downloadgitlab-ce-9ede66f619bb030ad351a7abf7b1be2148de7f99.tar.gz
Merge branch 'api-support-starred-projects' into 'master'
Api support for requesting starred projects for user Closes #4112 Note: probably targets the wrong release in the `CHANGELOG`, though 8.4 was not there yet See merge request !2127
Diffstat (limited to 'doc/api/projects.md')
-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).