usnationalarchives / OPAProd

Tracking enhancements to OPAProd
1 stars 0 forks source link

Streamline API interactive documentation sample queries #88

Open DominicBM opened 9 years ago

DominicBM commented 9 years ago

The API interactive documentation gives sample queries like https://catalog.archives.gov/api/v1?action=search&q=x&format=json&rows=25&offset=0. This is the same as https://catalog.archives.gov/api/v1?q=x, since these are all default and unnecessary parameters. It would be better for the sample queries to be promoting the use of cleaner query URLs. This also makes them easier to read and understand, without unnecessary parameters not related to the user's input. This principle should be applied throughout.