Improve description of SearchCustomers "q" param

bradfeehan · May 30, 2014 · 27aeee3 · 27aeee3
1 parent 68309c6
commit 27aeee3
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/lib/Desk/service-description/operations/Customer.group/SearchCustomers.yaml b/lib/Desk/service-description/operations/Customer.group/SearchCustomers.yaml
@@ -4,7 +4,12 @@ uri: customers/search
 responseClass: SearchCustomersPage
 parameters:
     q:
-        description: "Customer's to search across multiple fields with a single string"
+        description: >
+            Search across multiple fields with a single string. The
+            value of the q param is a string composed of one or more
+            search fields and values, with each set separated by a
+            space, such as group:general+subject:welcome. Note that
+            spaces must be represented as %20 or +.
         type: string
         location: query
     first_name: