Remaining API issues (from issue #52)

[gsrohde]

[Highest-priority items are in bold. See issue #172 for POST API tasks.]

• [ ] 1. Make more complete apipie documentation comments
  • import from psql table and field comments (more info + examples on summary page) (#317)
• [ ] 2. Make sure GitBook documentation of GET requests is up to date (GitBook should provide examples and point to api/docs/beta for full docs). Perhaps add link DOCS --> API (#318)
• [x] 3. Consider making key optional (can use curl -u option instead, or, for data access, work within a browser)
• [ ] 4. Add more testing (#319)
• [x] 5. Set return results encoding properly so that result display correctly in a browser (issue https://github.com/PecanProject/bety/issues/456).
• [x] 6. Fix broken /api/beta/search endpoint
• [x] 7. For traits and yields, don't return raw date, dateloc, and timeloc but return easily-interpretable date/time information instead.
• [x] 8. In API "list" endpoints, turn off returning ids of rows in associated tables by default.
• [ ] 9. Change endpoint from /api/beta to /api/v1 (#320)
  • add a duplicate endpoint called v1
  • we should plan on maintaining beta for a few years before deprecation

[ghost]

@dlebauer - what is the priority on this? Pre or post V0 release?

[dlebauer]

@gsrohde this needs to be done ASAP.

[gsrohde]

@dlebauer Regarding item 8: Now doing a query to, say, https://terraref.ncsa.illinois.edu/bety-test/api/beta/citations?key= won't try to show you a list of all ids of traits associated with each citation in the list (and then possibly time out because it takes too long). Instead, it only shows a count of the number of associated traits.

I've checked this fix into the master branch. I also changed it manually on bety7 (which is the instance that was timing out on these sorts of API calls), but I haven't done a new release yet that incorporates this fix. I don't think we've had timeout problems elsewhere, but if you want me to prioritize doing a release that incorporates this fix, let me know.

[dlebauer]

No rush to release

[dlebauer]

please parse remaining tasks into separate issues and close