Skip to content

Add docs for configurable limit #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 13, 2021
Merged

Add docs for configurable limit #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fc38486
Add docs for configurable limit
jozefcipa Jan 7, 2021
0c664fa
Update default maxLimit value
jozefcipa Jan 7, 2021
fc06327
Add limit to example code
derrickmehaffy Jan 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,3 +105,7 @@ dist

# Other
*.DS_Store

# IDE
.idea
.vscode
7 changes: 7 additions & 0 deletions developer-docs/latest/concepts/configurations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,10 @@ module.exports = ({ env }) => ({
responses: {
privateAttributes: ['_v', 'id', 'created_at'],
},
rest: {
defaultLimit: 100,
maxLimit: 250,
},
});
```

Expand All @@ -293,6 +297,9 @@ module.exports = ({ env }) => ({
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------- |
| `responses` | Global API response configuration | Object | |
| `responses.privateAttributes` | Set of globally defined attributes to be treated as private. E.g. `_v` when using MongoDb or timestamps like `created_at`, `updated_at` can be treated as private | String array | `[]` |
| `rest` | REST API configuration | Object | |
| `rest.defaultLimit` | Specifies default `_limit` parameter used in API calls | Integer | `100` |
| `rest.maxLimit` | Specifies max allowed number that can be requested as `_limit`. Default to `null` which fetches all results | Integer | `null` |

## Functions

Expand Down