ash-project / ash_json_api_wrapper Goto Github PK

I have an API that achieves pagination using query parameters in the URL. The maximum items returned is 50 so an offset/skip is needed to retrieve the full dataset

Is this possible using the library as-is? I have hacked it for now by adding a "skip" parameter to the resource that gets passed as a filter

read(:list_companies) do
    argument :skip, :integer do
        allow_nil? true
        default 0
    end

    filter expr(skip == ^arg(:skip))
end

The limit is working nicely as-is:

limit_with {:param, "limit"}

The resource generator doesn't support boolean properties.

%{"type" => "boolean"} ->
    ":boolean"

is needed around

Is your feature request related to a problem? Please describe.
The only sorting supported by this wrapper currently is :runtime_sort? which may be inefficient if the sorting is supported by the API.

Describe the solution you'd like
The ability to define and use sort_with and order_with properties in the endpoint definition

Describe alternatives you've considered
Currently I am using :runtime_sort?

Express the feature either with a change to resource syntax, or with a change to the resource interface

endpoint :list_users do
  path("/users")
  limit_with {:param, "limit"}
  sort_with {:param, "sortBy"}
  order_with {:param, "order"}
  # runtime_sort? true
  paginator CustomPaginator
end

I keep getting 404 when trying to access an endpoint. Apologies if this is simply me being a noob. Attached is a livebook illustrating my problem.

I would have expected the Tesla url to include /pet/findByStatus

petstore-20231020.livemd.zip