Skip to content

Commit a4154ca

Browse files
Raymond Camdenbajtos
authored andcommitted
Improve "filter" arg description
Add an example showing how to serialize object values as JSON.
1 parent 4278056 commit a4154ca

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

lib/persisted-model.js

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -749,7 +749,9 @@ module.exports = function(registry) {
749749
{ arg: 'id', type: 'any', description: 'Model id', required: true,
750750
http: {source: 'path'}},
751751
{arg: 'filter', type: 'object',
752-
description: 'Filter defining fields and include'},
752+
description:
753+
'Filter defining fields and include - must be a JSON-encoded string (' +
754+
'{"something":"value"})'},
753755
{arg: 'options', type: 'object', http: 'optionsFromRequest'},
754756
]),
755757
returns: {arg: 'data', type: typeName, root: true},
@@ -782,7 +784,8 @@ module.exports = function(registry) {
782784
accessType: 'READ',
783785
accepts: this._removeOptionsArgIfDisabled([
784786
{arg: 'filter', type: 'object', description:
785-
'Filter defining fields, where, include, order, offset, and limit'},
787+
'Filter defining fields, where, include, order, offset, and limit - must be a ' +
788+
'JSON-encoded string ({"something":"value"})'},
786789
{arg: 'options', type: 'object', http: 'optionsFromRequest'},
787790
]),
788791
returns: {arg: 'data', type: [typeName], root: true},
@@ -794,7 +797,8 @@ module.exports = function(registry) {
794797
accessType: 'READ',
795798
accepts: this._removeOptionsArgIfDisabled([
796799
{arg: 'filter', type: 'object', description:
797-
'Filter defining fields, where, include, order, offset, and limit'},
800+
'Filter defining fields, where, include, order, offset, and limit - must be a ' +
801+
'JSON-encoded string ({"something":"value"})'},
798802
{arg: 'options', type: 'object', http: 'optionsFromRequest'},
799803
]),
800804
returns: {arg: 'data', type: typeName, root: true},

0 commit comments

Comments
 (0)