Skip to content

fix: fixes parsing of sort fields #431

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
mattpolzin merged 1 commit into from
May 22, 2026
Merged

fix: fixes parsing of sort fields #431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions lib/jsonapi/plugs/query_parser.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,7 @@ defmodule JSONAPI.QueryParser do
|> Enum.map(fn field ->
valid_sort = Keyword.get(opts, :sort, [])
[_, direction, field] = Regex.run(~r/(-?)(\S*)/, field)
field = underscore(field)

unless field in valid_sort do
raise InvalidQuery, resource: config.view.type(), param: field, param_type: :sort
Expand Down
4 changes: 3 additions & 1 deletion test/jsonapi/plugs/query_parser_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,13 @@ defmodule JSONAPI.QueryParserTest do
end

test "parse_sort/2 turns sorts into valid ecto sorts" do
config = struct(Config, opts: [sort: ~w(name title)], view: MyView)
config = struct(Config, opts: [sort: ~w(name title updated_at)], view: MyView)
assert parse_sort(config, "name,title").sort == [asc: :name, asc: :title]
assert parse_sort(config, "name").sort == [asc: :name]
assert parse_sort(config, "-name").sort == [desc: :name]
assert parse_sort(config, "name,-title").sort == [asc: :name, desc: :title]
assert parse_sort(config, "updatedAt").sort == [asc: :updated_at]
assert parse_sort(config, "-updatedAt").sort == [desc: :updated_at]
end

test "parse_sort/2 raises on invalid sorts" do
Expand Down
Loading