Documentation of API error codes
Maintainers usually reply within 14 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 38/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- api, documentation
Research direction
The issue asks for a human-readable reference of HTTP status codes and error conditions per API endpoint, plus whether JSON errors always include a detail field. Start from existing API docs and the code that raises or serializes errors for each endpoint. Confirm observed status codes and payloads against the implementation. Done when docs list those conditions per endpoint; issue #359 is noted as a possible later source of the same information.
Written by the indexing model from the issue text.
Description
The docs currently do not contain a lot of information on possible error codes and conditions returned by the API. API clients therefore need to implement error handling based on observations and assumptions, and can not rely on documented behaviour.
It would be nice to have a reference of possible error conditions and HTTP status codes for each endpoint.
Furthermore, I noticed that errors seem to contain JSON data with a human-readable error message in the detail field. Is this always the case? At a quick glance, it seems to be. But I could not find any reliable information.
I believe, #359 has the potential to naturally provide this kind of information. In the mean time, a human-readable documentation would help.
- Dominant language
- Python
- Stars
- 678
- Forks
- 74
- Avg merge
- 7d 23h
- Merged PRs (30d)
- 1
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- No contributing guide
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.
More from desec-io/desec-stack
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
desec-io/desec-stack#1312 ·
Maintainers usually reply within 14 days
-
UI bug and inconsistency: Adding IPv6 address/netmask to token IP restriction silently errors outOpen
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
desec-io/desec-stack#1310 ·
Maintainers usually reply within 14 days
-
Here-strings in request examplesPossibly taken @jadhavgaurav claimed this 28 days ago. Opendocs help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
desec-io/desec-stack#1286 · 1 comment ·
Maintainers usually reply within 14 days
-
api enhancement prio: low
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
desec-io/desec-stack#1246 · 1 comment ·
Maintainers usually reply within 14 days
-
enhancement gui help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
desec-io/desec-stack#1181 · 1 comment ·
Maintainers usually reply within 14 days
All issues in desec-io/desec-stack
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
Maintainers usually reply within 1 day
-
Unused loot bag group names left in dreamcraft en_US.langPossibly taken A pull request linked to this issue is open or already merged. OpenStatus: Triage Suggestion
Difficulty 1/5 Under an hour Newbie friendliness 90/100
GTNewHorizons/GT-New-Horizons-Modpack#27789 ·
Maintainers usually reply within 1 day
-
bug frontend sev-5
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
-
core good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
b4b code health next
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
ESCOMP/CTSM#4330 · 1 comment ·
Maintainers usually reply within 1 day