Skip to main content

Module api

Module api 

Source

Structs§

OrderingParams
How the API takes a sort: one query param naming the column, with a prefix that flips it to descending (?ordering=-net, the Django REST Framework and Launch Library convention). Configuring it makes the REST vista orderable, so a paged grid asks the server for its sort instead of re-sorting the rows it happens to hold.
PaginationParams
Names of the page/limit query parameters the API expects.
RestApi
RestApiBuilder
Builder for RestApi. Lets callers pick a ResponseShape and override the pagination parameter names.

Enums§

FilterStrategy
REST API backend for Vantage — reads data from HTTP JSON endpoints.
ResponseShape
How the API wraps its row array in the response body.