statbotics icon indicating copy to clipboard operation
statbotics copied to clipboard

Add documentation for API fields to website

Open Ronoman opened this issue 1 year ago • 2 comments

As far as I can tell, there isn't an explicit definition for each field in the REST or Python API (or the matching fields in the downloadable CSVs). Many of the fields are self explanatory (year, team, etc.), but some aren't as simple (epa_start, rp_1_mse, etc). It would be very useful to have a one or two sentence description of values and derived values, as well as a type and whether null is valid for the field.

If this documentation exists and I just haven't found it, feel free to close!

Ronoman avatar Apr 27 '23 18:04 Ronoman

Well that was quick, it exists here: https://github.com/avgupta456/statbotics/blob/master/docs/API.md. I guess the request is to either link to this or add the corresponding table to one or both API documentation pages on the frontend, and specify which fields for each schema are nullable.

Ronoman avatar Apr 27 '23 18:04 Ronoman

I agree it should be added to the website. I'll work on getting that done soon.

avgupta456 avatar Apr 27 '23 19:04 avgupta456