better return types documentation - Githubissues

sensebox / openSenseMap-API

API for opensensemap.org

https://docs.opensensemap.org/

MIT License

48 stars 41 forks source link

better return types documentation #821

Closed mpfeil closed 1 year ago

mpfeil commented 1 year ago

Description

Add return values and response examples to /boxes route documentation

Will be adding more over the time

Closes #782

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[x] My code has been linted using yarn run lint.
[x] My code does not break the tests (yarn run test)
[ ] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.
[x] I have read the CONTRIBUTING document.