AtlasOfLivingAustralia / biocache-service

Occurrence & mapping webservices
https://biocache-ws.ala.org.au/ws/
Other
9 stars 26 forks source link

Add `pageSize` for offline downloads API (occurrences/offline/download) #829

Closed adam-collins closed 7 months ago

adam-collins commented 11 months ago

1. Add pageSize for offline downloads API

Request to add pageSize to offline downloads API to enable galah users to check result output before downloading all records. (Chat thread on Slack if further info required)

requested by @mjwestgate

2. Update to API docs

The API docs on Swagger show additional arguments that do not work for occurrences/offline/download. These should be removed to avoid confusion.

These arguments include dir but there may be others.

adam-collins commented 11 months ago

The intended use is to preview results. Some considerations.

Any additional thoughts @djtfmartin ?

adam-collins commented 11 months ago

The provided pageSize must differ from the default pageSize of 10

djtfmartin commented 11 months ago

@adam-collins I am wondering if this requirement would be better served with a newer version (v2) of the /occurrence/search JSON API that returned the full darwin core record - which would be closer to the set of fields in download.

Currently the /occurrences/search just returns a small number of fields that where there to just support the UI - not very useful as a general application.

@mjwestgate how does this sound ?

this is probably just a different way of thinking of it, but i've thought for some time that we would have a better JSON occurrence search service that allowed access to a bigger range of the fields indexed.

adam-collins commented 7 months ago

I agree and am not aware of any discussion. No changes required. Closing.