Merge pull request #4158 from strongloop/fixFilterDef

Update the description for persisted-models
strongloop · Mar 15, 2019 · a9a86fe · a9a86fe
2 parents c8a31e2 + b83f563
commit a9a86fe
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/lib/persisted-model.js b/lib/persisted-model.js
@@ -797,7 +797,9 @@ module.exports = function(registry) {
       accepts: [
         {arg: 'filter', type: 'object', description:
         'Filter defining fields, where, include, order, offset, and limit - must be a ' +
-        'JSON-encoded string ({"something":"value"})'},
+        'JSON-encoded string (`{"where":{"something":"value"}}`).  ' +
+        'See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries ' +
+        'for more details.'},
         {arg: 'options', type: 'object', http: 'optionsFromRequest'},
       ],
       returns: {arg: 'data', type: [typeName], root: true},
@@ -810,7 +812,9 @@ module.exports = function(registry) {
       accepts: [
         {arg: 'filter', type: 'object', description:
         'Filter defining fields, where, include, order, offset, and limit - must be a ' +
-        'JSON-encoded string ({"something":"value"})'},
+        'JSON-encoded string (`{"where":{"something":"value"}}`).  ' +
+        'See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries ' +
+        'for more details.'},
         {arg: 'options', type: 'object', http: 'optionsFromRequest'},
       ],
       returns: {arg: 'data', type: typeName, root: true},