search

AICPA-ADS / AuditData-API

Working Draft of Audit Data API
MIT License
9 stars 4 forks source link

Pagination #5

Open campbellpryde opened 4 years ago

campbellpryde commented 4 years ago

Do we address pageination in the API.

valorekhov commented 4 years ago

Related to #6, will research and propose an available standard to support the same. Swagger Pagination or ODATA already have an approach for the same.

valorekhov commented 4 years ago

As proposed in a comment on #6, I'd like to recommend keeping pagination out of the base spec, or at least, treating it as an optional feature.

If it were part of the base functionality, a provider would have to custom code pagination logic to conform with the spec. Further, we'll have to provide guidance on whether offset or cursor-type pagination to implement, which may not work will every backend.

Alternatively, a provider may opt to base their implementation on a pre-canned framework like OData or JSON-API which will provide pagination logic, as well as other goodies like a partial field set on responses, sorting, etc.