NationalMuseumAustralia / Collection-API

The public web API of the National Museum of Australia
11 stars 0 forks source link

Doco - review searchable fields #116

Open f27wood opened 5 years ago

f27wood commented 5 years ago

I was looking for doco on how somebody would identify if an object is on display and what gallery it is in, and could not find this info. I think it just needs to be added to the searchable fields in the getting started guide?

So adding this issue to review that part of the guide as there are probably other fields not included as they did not exist when it was first written.

Conal-Tuohy commented 5 years ago

See the note in https://github.com/NationalMuseumAustralia/Collection-API/wiki/Getting-started#beta-release-known-issues and review.

Conal-Tuohy commented 5 years ago
Conal-Tuohy commented 5 years ago

Leave out id, hash (for internal use only) and reason, since it adds nothing to status_code, which is documented.

Conal-Tuohy commented 5 years ago

sourceCount is another for internal use only (part of the incremental update accounting mechanism)

Conal-Tuohy commented 5 years ago

type is also not for use as a search field; it is part of the "path" component of query URLs, e.g. object, media, etc.

Conal-Tuohy commented 5 years ago

Remaining issues the _date fields, the spatial_geo field, and the various unpopulated dimension fields. I will raise these as separate issues and close off this issue.