Merge pull request #3219 from strongloop/backport/fix-filter-desc

Improve "filter" arg description
This commit is contained in:
Miroslav Bajtoš 2017-02-21 17:28:51 +01:00 committed by GitHub
commit 68d55b523e
1 changed files with 7 additions and 3 deletions

View File

@ -749,7 +749,9 @@ module.exports = function(registry) {
{ arg: 'id', type: 'any', description: 'Model id', required: true,
http: {source: 'path'}},
{arg: 'filter', type: 'object',
description: 'Filter defining fields and include'},
description:
'Filter defining fields and include - must be a JSON-encoded string (' +
'{"something":"value"})'},
{arg: 'options', type: 'object', http: 'optionsFromRequest'},
]),
returns: {arg: 'data', type: typeName, root: true},
@ -782,7 +784,8 @@ module.exports = function(registry) {
accessType: 'READ',
accepts: this._removeOptionsArgIfDisabled([
{arg: 'filter', type: 'object', description:
'Filter defining fields, where, include, order, offset, and limit'},
'Filter defining fields, where, include, order, offset, and limit - must be a ' +
'JSON-encoded string ({"something":"value"})'},
{arg: 'options', type: 'object', http: 'optionsFromRequest'},
]),
returns: {arg: 'data', type: [typeName], root: true},
@ -794,7 +797,8 @@ module.exports = function(registry) {
accessType: 'READ',
accepts: this._removeOptionsArgIfDisabled([
{arg: 'filter', type: 'object', description:
'Filter defining fields, where, include, order, offset, and limit'},
'Filter defining fields, where, include, order, offset, and limit - must be a ' +
'JSON-encoded string ({"something":"value"})'},
{arg: 'options', type: 'object', http: 'optionsFromRequest'},
]),
returns: {arg: 'data', type: typeName, root: true},