From 9d55bc0002c41de9a59e505982356efb0907a9a3 Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Tue, 3 Dec 2013 12:15:30 -0800 Subject: [PATCH] Sadly, HTML table format is unusable in documentation wiki. Revert to lame md format. --- docs/rest.md | 107 ++++++++++++++++----------------------------------- 1 file changed, 34 insertions(+), 73 deletions(-) diff --git a/docs/rest.md b/docs/rest.md index 3e8c8db9..3b2d326c 100644 --- a/docs/rest.md +++ b/docs/rest.md @@ -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 values, as described in the following table. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Filter typeTypeDescription
whereObjectSearch criteria. Format: {key: val} or {key: {op: val}} -

Operations:

-
    -
  • gt: >
    • -
  • gte: >=
    • -
  • lt: <
    • -
  • lte: <=
    • -
  • between
    • -
  • inq: IN
    • -
  • nin: NOT IN
    • -
  • neq: !=
    • -
  • like: LIKE
    • -
  • nlike: NOT LIKE
    • -
-
includeString, Object, or ArrayAllows you to load relations of several objects and optimize numbers of requests. -

Format:

-
    -
  • posts: Load posts
    • -
  • [posts, passports]: Load posts and passports.
    • -
  • {owner: posts}: Load owner and owner's posts.
    • -
  • {owner: [posts, passports]}: Load owner, owner's posts, and owner's passports.
    • -
  • {owner: [{posts: images}, passports]}: Load owner, owner's posts, owner's posts' images, and owner's passports.
    • -
-
orderStringSort order. Format: 'key1 ASC, key2 DESC' where ASC specifies ascending and DESC specifies descending order.
limitNumberMaximum number of instances to return.
skip (offset)NumberSkip specified number of instances. Use offset as alternative.
fieldsObject, Array, or StringThe included/excluded fields: -
    -
  • -[foo] or foo - include only the foo property.
    • -
  • -[foo, bar] - include the foo and bar properties
    • -
  • -{foo: true} - include only foo
    • -
  • -{bat: false} - include all properties, exclude bat
    • -
-
+| Filter type | Type | Description | +| ------------- | ------------- | ---------------| +| where | Object | Search criteria. Format: `{key: val}` or `{key: {op: val}}` For list of valid operations, see Operations, below. | +| include | String, Object, or Array | Allows you to load relations of several objects and optimize numbers of requests. For format, see Include format, below. | +| order | String | Sort order. Format: 'key1 ASC, key2 DESC', where ASC specifies ascending and DESC specifies descending order. | +|limit| Number | Maximum number of instances to return. | +|skip (offset) | Number | Skip the specified number of instances. Use offset as alternative. | +|fields| Object, Array, or String | The included/excluded fields. For foramt, see fields below. + +**Operations**: +- gt: > +- gte: >= +- lt: < +- lte: <= +- between +- inq: IN +- nin: NOT IN +- neq: != +- like: LIKE +- nlike: NOT LIKE + +**Include format**: + - 'posts': Load posts + - ['posts', 'passports']: Load posts and passports + - {'owner': 'posts'}: Load owner and owner's posts + - {'owner': ['posts', 'passports']}: Load owner, owner's posts, and owner's passports + - {'owner': [{posts: 'images'}, 'passports']}: Load owner, owner's posts, owner's posts' images, and owner's passports + +*Fields*: + - `['foo']` or `'foo'` - include only the foo property + - `['foo', 'bar']` - include the foo and bar properties + - `{foo: true}` - include only foo + - `{bat: false}` - include all properties, exclude bat + For example,