Skip to content
Browse files

search draft

  • Loading branch information...
1 parent fad0657 commit 9d56742c6713268cf76aeb8994c4cc34d8666fd8 @rloads rloads committed Sep 21, 2012
Showing with 13 additions and 7 deletions.
  1. +13 −7 search.md
View
20 search.md
@@ -6,7 +6,7 @@ Search
Resource Scope
--------------
-* `GET /search?q=lion` will search for all 5 resources which has keyword `lion`.
+* `GET /search?q=lion` will search for all 5 resources with keyword `lion`.
* `GET /search?q=lion&resource=Workspace` will search for workspaces only.
* `GET /search?q=lion&resource=Workspace,File` will search for workspaces and files.
@@ -32,15 +32,15 @@ Response
```
`type` denotes the type of the content which can be `Workspace`, `Comment`, `File`, `Page` and `Task`.
-`content` will be the exact same JSON representation of each resources described in this documentation.
-For detail, see the 'GET' section of each resources.
+`content` will be the exact same JSON representation of each resources described in other documentation.
+For details, see the 'GET' section of each resources.
Common Filter Options
--------------------
-* `GET /search?page=2` to get next page of the search results. The search result will be paginated 30 items per page.
-* `GET /search?order_by=updated_at+desc` will return sorted results by `updated_at` field of the results.
-* `GET /search?order_by=created_at+desc` will return sorted results by `created_at` field of the results.
+* `GET /search?page=2` to get the page two of the search results. The search result will be paginated 30 items per page.
+* `GET /search?order_by=updated_at+desc` will return sorted results by `updated_at` field.
+* `GET /search?order_by=created_at+desc` will return sorted results by `created_at` field.
* `GET /search?updated_since=1997-08-14T15:39:07-07:00` will return resources updated after the given time.
* `GET /search?created_since=1984-08-14T15:39:07-07:00` will return resources created after the given time.
@@ -55,4 +55,10 @@ Resource Dependent Filter Options
GET /workspaces?state=archived
-See each individual document to get more details on filter options.
+See API documents for each resource types to get more details on filter options.
+
+* [Workspace](https://github.com/vispower/teamplatform-api/blob/master/workspace.md)
+* [Comment](https://github.com/vispower/teamplatform-api/blob/master/comment.md)
+* [File](https://github.com/vispower/teamplatform-api/blob/master/file.md)
+* [Page](https://github.com/vispower/teamplatform-api/blob/master/page.md)
+* [Task](https://github.com/vispower/teamplatform-api/blob/master/task.md)

0 comments on commit 9d56742

Please sign in to comment.
Something went wrong with that request. Please try again.