NatLabRockies / NatLabRockies/developer.nlr.gov
Possible "warnings" in API responses is undocumented
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 60
- Forks
- 57
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 3
Description
Feedback from our API Usability Testing: In several of our APIs we have documented that we may return warnings in the response. However, it isn't clear what these warnings might entail, or how the API consumer should respond to warnings. We should also disambiguate that from what errors mean.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the existing warning documentation linked from the issue, along with the surrounding API response and error guidance. Done means the documentation explains what warnings contain, how consumers should respond, and how warnings differ from errors across the affected APIs.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100