Fixing API documentation for search string fields (#478)

Netflix · Mar 8, 2017 · 22e3be3 · 22e3be3
1 parent 008b8bd
commit 22e3be3
Showing 1 changed file with 10 additions and 8 deletions.
diff --git a/genie-web/src/test/java/com/netflix/genie/web/controllers/Snippets.java b/genie-web/src/test/java/com/netflix/genie/web/controllers/Snippets.java
@@ -243,11 +243,11 @@ final class Snippets {
             getCommonSearchParameters(),
             RequestDocumentation
                 .parameterWithName("name")
-                .description("The name of the applications to find.")
+                .description("The name of the applications to find. Use % to perform a regex like query")
                 .optional(),
             RequestDocumentation
                 .parameterWithName("user")
-                .description("The user of the applications to find.")
+                .description("The user of the applications to find. Use % to perform a regex like query")
                 .optional(),
             RequestDocumentation
                 .parameterWithName("status")
@@ -262,7 +262,7 @@ final class Snippets {
                 .optional(),
             RequestDocumentation
                 .parameterWithName("type")
-                .description("The type of the applications to find.")
+                .description("The type of the applications to find. Use % to perform a regex like query")
                 .optional()
         )
     );
@@ -299,11 +299,11 @@ final class Snippets {
             getCommonSearchParameters(),
             RequestDocumentation
                 .parameterWithName("name")
-                .description("The name of the commands to find.")
+                .description("The name of the commands to find. Use % to perform a regex like query")
                 .optional(),
             RequestDocumentation
                 .parameterWithName("user")
-                .description("The user of the commands to find.")
+                .description("The user of the commands to find. Use % to perform a regex like query")
                 .optional(),
             RequestDocumentation
                 .parameterWithName("status")
@@ -331,7 +331,7 @@ final class Snippets {
                 .optional(),
             RequestDocumentation
                 .parameterWithName("user")
-                .description("The user of the jobs to find.")
+                .description("The user of the jobs to find. Use % symbol for regex like search.")
                 .optional(),
             RequestDocumentation
                 .parameterWithName("status")
@@ -346,15 +346,17 @@ final class Snippets {
                 .optional(),
             RequestDocumentation
                 .parameterWithName("clusterName")
-                .description("The name of the cluster on which the jobs ran.")
+                .description("The name of the cluster on which the jobs ran. Use % symbol for regex like search.")
                 .optional(),
             RequestDocumentation
                 .parameterWithName("clusterId")
                 .description("The id of the cluster on which the jobs ran.")
                 .optional(),
             RequestDocumentation
                 .parameterWithName("commandName")
-                .description("The name of the command which was executed by the job.")
+                .description(
+                    "The name of the command which was executed by the job. Use % symbol for regex like search."
+                )
                 .optional(),
             RequestDocumentation
                 .parameterWithName("commandId")