Skip to content

Commit

Permalink
Merge pull request #918 from shdehnavi/installation-setup-doc
Browse files Browse the repository at this point in the history
[Docs] Update config file content
  • Loading branch information
freekmurze authored Jan 14, 2024
2 parents 86b78d8 + 4ab2810 commit 93edc4c
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion docs/installation-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,34 @@ return [
* For example: GET /users?include=postsExists
*/
'exists_suffix' => 'Exists',

/*
* By default the package will throw an `InvalidFilterQuery` exception when a filter in the
* URL is not allowed in the `allowedFilters()` method.
*/
'disable_invalid_filter_query_exception' => false,

/*
* By default the package will throw an `InvalidSortQuery` exception when a sort in the
* URL is not allowed in the `allowedSorts()` method.
*/
'disable_invalid_sort_query_exception' => false,

/*
* By default the package will throw an `InvalidIncludeQuery` exception when an include in the
* URL is not allowed in the `allowedIncludes()` method.
*/
'disable_invalid_includes_query_exception' => false,

/*
* By default, the package expects relationship names to be snake case plural when using fields[relationship].
* For example, fetching the id and name for a userOwner relation would look like this:
* GET /users?fields[user_owner]=id,name
*
* Set this to `false` if you don't want that and keep the requested relationship names as-is and allows you to
* request the fields using a camelCase relationship name:
* GET /users?fields[userOwner]=id,name
*/
'convert_relation_names_to_snake_case_plural' => true,
];
```

0 comments on commit 93edc4c

Please sign in to comment.