verdnatura-mirror
/
loopback
mirror of https://github.com/strongloop/loopback.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sadly, HTML table format is unusable in documentation wiki. Revert to lame md format.

This commit is contained in:
Rand McKinney 2013-12-03 12:15:30 -08:00
parent 0fe86cf723
commit 9d55bc0002
1 changed files with 34 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

107
docs/rest.md
View File

@ -173,79 +173,40 @@ Pass the arguments as the value of the `find` HTTP query parameter, as follows
where *filterType1*, *filterType2*, and so on, are the filter types, and *val1*, *val2* are the corresponding where *filterType1*, *filterType2*, and so on, are the filter types, and *val1*, *val2* are the corresponding
values, as described in the following table. values, as described in the following table.
<table> | Filter type | Type | Description |
<thead><tr> | ------------- | ------------- | ---------------|
<th>Filter type</th> | where | Object | Search criteria. Format: `{key: val}` or `{key: {op: val}}` For list of valid operations, see Operations, below. |
<th>Type</th> | include | String, Object, or Array | Allows you to load relations of several objects and optimize numbers of requests. For format, see Include format, below. |
<th>Description</th> | order | String | Sort order. Format: 'key1 ASC, key2 DESC', where ASC specifies ascending and DESC specifies descending order. |
</tr></thead> |limit| Number | Maximum number of instances to return. |
<tbody> |skip (offset) | Number | Skip the specified number of instances. Use offset as alternative. |
<tr> |fields| Object, Array, or String | The included/excluded fields. For foramt, see fields below.
<td>where</td>
<td>Object</td> **Operations**:
<td>Search criteria. Format: <code>{key: val}</code> or <code>{key: {op: val}}</code> - gt: >
<p>Operations:</p> - gte: >=
<ul> - lt: <
<li>gt: &gt;</li> - lte: <=
<li>gte: &gt;=</li> - between
<li>lt: &lt;</li> - inq: IN
<li>lte: &lt;=</li> - nin: NOT IN
<li>between</li> - neq: !=
<li>inq: IN</li> - like: LIKE
<li>nin: NOT IN</li> - nlike: NOT LIKE
<li>neq: !=</li>
<li>like: LIKE</li> **Include format**:
<li>nlike: NOT LIKE</li> - 'posts': Load posts
</ul> - ['posts', 'passports']: Load posts and passports
</td> - {'owner': 'posts'}: Load owner and owner's posts
</tr> - {'owner': ['posts', 'passports']}: Load owner, owner's posts, and owner's passports
<tr> - {'owner': [{posts: 'images'}, 'passports']}: Load owner, owner's posts, owner's posts' images, and owner's passports
<td>include</td>
<td>String, Object, or Array</td> *Fields*:
<td>Allows you to load relations of several objects and optimize numbers of requests. - `['foo']` or `'foo'` - include only the foo property
<p>Format:</p> - `['foo', 'bar']` - include the foo and bar properties
<ul> - `{foo: true}` - include only foo
<li><code>posts</code>: Load posts</li> - `{bat: false}` - include all properties, exclude bat
<li><code>[posts, passports]</code>: Load posts and passports.</li>
<li><code>{owner: posts}</code>: Load owner and owner's posts.</li>
<li><code>{owner: [posts, passports]}</code>: Load owner, owner's posts, and owner's passports.</li>
<li><code>{owner: [{posts: images}, passports]}</code>: Load owner, owner's posts, owner's posts' images, and owner's passports.</li>
</ul>
</td>
</tr>
<tr>
<td>order</td>
<td>String</td>
<td>Sort order. Format: 'key1 ASC, key2 DESC' where ASC specifies ascending and DESC specifies descending order.</td>
</tr>
<tr>
<td>limit</td>
<td>Number</td>
<td>Maximum number of instances to return.</td>
</tr>
<tr>
<td>skip (offset)</td>
<td>Number</td>
<td>Skip specified number of instances. Use offset as alternative.</td>
</tr>
<tr>
<td>fields</td>
<td>Object, Array, or String</td>
<td>The included/excluded fields:
<ul>
<li>
<code>[foo]</code> or <code>foo</code> - include only the foo property.</li>
<li>
<code>[foo, bar]</code> - include the foo and bar properties</li>
<li>
<code>{foo: true}</code> - include only foo</li>
<li>
<code>{bat: false}</code> - include all properties, exclude bat</li>
</ul>
</td>
</tr>
</tbody>
</table>
For example, For example,