Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve API and CSV template upload documentation with field values and formats #25

Open
scottveirs opened this issue Oct 5, 2023 · 0 comments
Assignees
Labels
2023 documentation Improvements or additions to documentation

Comments

@scottveirs
Copy link
Collaborator

scottveirs commented Oct 5, 2023

The current Acartia API documentation (at least in or near the CONTRIBUTING.md file) could be enriched by offering allowed values for each field, along with the expected format of the value. It may also be helpful to surface the variable_name used internally for each field.

A good example of this sort of API documentation can be found in the iNaturalist API reference pages:

Screenshot 2023-10-05 at 9 56 10 AM

Ideally, this issue should be tackled after a revision of the data schema (to accommodate acoustic detections and group tags, e.g. for defining tracks of pods, matrilines, or individuals).

A subsequent step could be error checking incoming data to ensure the field names, values, and formats are acceptable -- and providing useful feedback regarding failed quality control checks.

@scottveirs scottveirs added documentation Improvements or additions to documentation 2023 labels Oct 5, 2023
@scottveirs scottveirs self-assigned this Oct 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2023 documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

1 participant