From b91938ecdfbce29fcf11e912c21c7ea195819ef4 Mon Sep 17 00:00:00 2001 From: Quentin Presley Date: Fri, 15 Mar 2019 07:39:40 -0700 Subject: [PATCH 1/3] Update the description for persisted-models --- lib/persisted-model.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/persisted-model.js b/lib/persisted-model.js index 2d5080f6..2627c651 100644 --- 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}, From 6caf506769d9450668f03df5ef9e6feefc1fa7a5 Mon Sep 17 00:00:00 2001 From: Quentin Presley Date: Fri, 15 Mar 2019 07:43:13 -0700 Subject: [PATCH 2/3] Add same change to description for findOne --- lib/persisted-model.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/persisted-model.js b/lib/persisted-model.js index 2627c651..9b6d1968 100644 --- a/lib/persisted-model.js +++ b/lib/persisted-model.js @@ -812,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}, From b83f5635cf5b914021a1f2fca6cba7788ad0f121 Mon Sep 17 00:00:00 2001 From: Quentin Presley Date: Fri, 15 Mar 2019 07:46:15 -0700 Subject: [PATCH 3/3] Back-ticks added to highlight example JSON --- lib/persisted-model.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/persisted-model.js b/lib/persisted-model.js index 9b6d1968..1a3bfb78 100644 --- a/lib/persisted-model.js +++ b/lib/persisted-model.js @@ -797,7 +797,7 @@ 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 ({"where":{"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'}, @@ -812,7 +812,7 @@ 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 ({"where":{"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'},