From e26950671cc9683b08d74ecfe9c8d6dfa3966e8c Mon Sep 17 00:00:00 2001
From: Athou <jeremiepanzer@gmail.com>
Date: Sun, 11 Aug 2013 11:50:30 +0200
Subject: [PATCH] clarify documentation: keywords are not required

---
 .../frontend/rest/resources/CategoryREST.java | 19 ++++++++----------
 .../frontend/rest/resources/FeedREST.java     | 20 +++++++++----------
 2 files changed, 17 insertions(+), 22 deletions(-)

diff --git a/src/main/java/com/commafeed/frontend/rest/resources/CategoryREST.java b/src/main/java/com/commafeed/frontend/rest/resources/CategoryREST.java
index 3664413e..a2566770 100644
--- a/src/main/java/com/commafeed/frontend/rest/resources/CategoryREST.java
+++ b/src/main/java/com/commafeed/frontend/rest/resources/CategoryREST.java
@@ -95,17 +95,14 @@ public class CategoryREST extends AbstractREST {
 			notes = "Get a list of category entries",
 			responseClass = "com.commafeed.frontend.model.Entries")
 	public Response getCategoryEntries(
-			@ApiParam(value = "id of the category, 'all' or 'starred'", required = true) @QueryParam("id") String id, @ApiParam(
-					value = "all entries or only unread ones",
-					allowableValues = "all,unread",
-					required = true) @DefaultValue("unread") @QueryParam("readType") ReadingMode readType, @ApiParam(
-					value = "only entries newer than this") @QueryParam("newerThan") Long newerThan,
-			@ApiParam(value = "offset for paging") @DefaultValue("0") @QueryParam("offset") int offset, @ApiParam(
-					value = "limit for paging, default 20, maximum 1000") @DefaultValue("20") @QueryParam("limit") int limit, @ApiParam(
-					value = "date ordering",
-					allowableValues = "asc,desc") @QueryParam("order") @DefaultValue("desc") ReadingOrder order, @ApiParam(
-					value = "keywords separated by spaces, 3 characters minimum",
-					required = true) @QueryParam("keywords") String keywords,
+			@ApiParam(value = "id of the category, 'all' or 'starred'", required = true) @QueryParam("id") String id,
+			@ApiParam(value = "all entries or only unread ones", allowableValues = "all,unread", required = true) @DefaultValue("unread") @QueryParam("readType") ReadingMode readType,
+			@ApiParam(value = "only entries newer than this") @QueryParam("newerThan") Long newerThan,
+			@ApiParam(value = "offset for paging") @DefaultValue("0") @QueryParam("offset") int offset,
+			@ApiParam(value = "limit for paging, default 20, maximum 1000") @DefaultValue("20") @QueryParam("limit") int limit,
+			@ApiParam(value = "date ordering", allowableValues = "asc,desc") @QueryParam("order") @DefaultValue("desc") ReadingOrder order,
+			@ApiParam(
+					value = "search for keywords in either the title or the content of the entries, separated by spaces, 3 characters minimum") @QueryParam("keywords") String keywords,
 			@ApiParam(value = "return only entry ids") @DefaultValue("false") @QueryParam("onlyIds") boolean onlyIds) {
 
 		Preconditions.checkNotNull(readType);
diff --git a/src/main/java/com/commafeed/frontend/rest/resources/FeedREST.java b/src/main/java/com/commafeed/frontend/rest/resources/FeedREST.java
index 49610479..48db57a0 100644
--- a/src/main/java/com/commafeed/frontend/rest/resources/FeedREST.java
+++ b/src/main/java/com/commafeed/frontend/rest/resources/FeedREST.java
@@ -132,17 +132,15 @@ public class FeedREST extends AbstractREST {
 	@Path("/entries")
 	@GET
 	@ApiOperation(value = "Get feed entries", notes = "Get a list of feed entries", responseClass = "com.commafeed.frontend.model.Entries")
-	public Response getFeedEntries(@ApiParam(value = "id of the feed", required = true) @QueryParam("id") String id, @ApiParam(
-			value = "all entries or only unread ones",
-			allowableValues = "all,unread",
-			required = true) @DefaultValue("unread") @QueryParam("readType") ReadingMode readType, @ApiParam(
-			value = "only entries newer than this") @QueryParam("newerThan") Long newerThan,
-			@ApiParam(value = "offset for paging") @DefaultValue("0") @QueryParam("offset") int offset, @ApiParam(
-					value = "limit for paging, default 20, maximum 1000") @DefaultValue("20") @QueryParam("limit") int limit, @ApiParam(
-					value = "date ordering",
-					allowableValues = "asc,desc") @QueryParam("order") @DefaultValue("desc") ReadingOrder order, @ApiParam(
-					value = "keywords separated by spaces, 3 characters minimum",
-					required = true) @QueryParam("keywords") String keywords,
+	public Response getFeedEntries(
+			@ApiParam(value = "id of the feed", required = true) @QueryParam("id") String id,
+			@ApiParam(value = "all entries or only unread ones", allowableValues = "all,unread", required = true) @DefaultValue("unread") @QueryParam("readType") ReadingMode readType,
+			@ApiParam(value = "only entries newer than this") @QueryParam("newerThan") Long newerThan,
+			@ApiParam(value = "offset for paging") @DefaultValue("0") @QueryParam("offset") int offset,
+			@ApiParam(value = "limit for paging, default 20, maximum 1000") @DefaultValue("20") @QueryParam("limit") int limit,
+			@ApiParam(value = "date ordering", allowableValues = "asc,desc") @QueryParam("order") @DefaultValue("desc") ReadingOrder order,
+			@ApiParam(
+					value = "search for keywords in either the title or the content of the entries, separated by spaces, 3 characters minimum") @QueryParam("keywords") String keywords,
 			@ApiParam(value = "return only entry ids") @DefaultValue("false") @QueryParam("onlyIds") boolean onlyIds) {
 
 		Preconditions.checkNotNull(id);