From 9d06921ffb2082cdcb6bcce3e420d53011a3b71d Mon Sep 17 00:00:00 2001 From: Izaak Alpert Date: Mon, 23 Sep 2013 19:18:29 -0400 Subject: Added missing API documentation Change-Id: I1337ee7ff51d018d6f62d447345032597e84269f --- doc/api/projects.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'doc/api') diff --git a/doc/api/projects.md b/doc/api/projects.md index 9afffcbaa80..380f6f21ce8 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -484,3 +484,18 @@ DELETE /projects/:id/fork Parameter: + `id` (required) - The ID of the project + + +## Search for projects by name + +Search for projects by name which are public or the calling user has access to + +``` +GET /projects/search/:query +``` + +Parameters: + ++ query (required) - A string contained in the project name ++ per_page (optional) - number of projects to return per page, defaults to 20 ++ offset (optional) - the offset in pages to retrieve -- cgit v1.2.1 From 04c7c262a7be469a4ae4865464b003c4b522a895 Mon Sep 17 00:00:00 2001 From: Izaak Alpert Date: Tue, 24 Sep 2013 09:22:46 -0400 Subject: Used pagnation function from api helpers Change-Id: I1bdd3608d3b46924b5da3ae282c99f85ee4e0dab --- doc/api/projects.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/api') diff --git a/doc/api/projects.md b/doc/api/projects.md index 380f6f21ce8..5150331e7d7 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -497,5 +497,5 @@ GET /projects/search/:query Parameters: + query (required) - A string contained in the project name -+ per_page (optional) - number of projects to return per page, defaults to 20 -+ offset (optional) - the offset in pages to retrieve ++ per_page (optional) - number of projects to return per page ++ page (optional) - the page to retrieve -- cgit v1.2.1