Skip to content

Commit 23adbed

Browse files
committed
Readme update for config.raise_if_parameters_not_allowed
1 parent 3018fab commit 23adbed

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1282,6 +1282,12 @@ JSONAPI.configure do |config|
12821282
config.allow_sort = true
12831283
config.allow_filter = true
12841284

1285+
# How to handle unsupported attributes and relationships which are provided in the request
1286+
# true => raises an error
1287+
# false => allows the request to continue. A warning is included in the response meta data indicating
1288+
# the fields which were ignored. This is useful for client libraries which send extra parameters.
1289+
config.raise_if_parameters_not_allowed = true
1290+
12851291
# :none, :offset, :paged, or a custom paginator name
12861292
config.default_paginator = :none
12871293

0 commit comments

Comments
 (0)