Standardize request handlers, esp exception handling
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
Research direction
Start with backend/app/api/routes/ban_lists.py, especially lines 14-27, then inspect the other route handlers for their current happy-path response behavior. Look for existing status-message and exception-handling conventions before determining the scope. Done means all request handlers use the agreed response syntax and provide meaningful exception responses.
Written by the indexing model from the issue text.
Description
Which feature or component needs enhancement?
All request handlers associated with routes.
Describe the current behavior
There are route handlers that only have the happy path of a request handling flow.
For instance
https://github.com/ProjectTech4DevAI/kaapi-guardrails/blob/1d62fc24821ca6e7b5c7d8aeb473fc9052787a4d/backend/app/api/routes/ban_lists.py#L14-L27
Describe the enhancement you'd like
Finalize a syntax for status response messages and the amount of information to include in them and start adding some exception handlers to the request handler functions.
Why is this enhancement needed?
The kaapi team and any downstream API users of kaapi API will get meaningful error messages.
- Dominant language
- Python
- Stars
- 5
- Forks
- 4
- Avg merge
- 11d 19h
- Merged PRs (30d)
- 1
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a 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 ProjectTech4DevAI/kaapi-guardrails
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
-
Callback Enhancement: Include intermediate responsesPossibly taken @Prajna1999 claimed this 26 days ago. Open
ProjectTech4DevAI/kaapi-guardrails#158 · 1 assignee ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
All issues in ProjectTech4DevAI/kaapi-guardrails
Similar issues
-
needs-human needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
gke-labs/kube-agents#2400 · 1 comment ·
Maintainers usually reply within 1 day
-
Device Details tables: FS/SF columns contradict each other (nfet_01v8 Vt row, pfet_01v8 Idsat row)Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
google/skywater-pdk#450 ·
-
Drained trajectory arrays are overwritten when the sequence buffer is reusedPossibly taken @sylvesterkaczmarek claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
google-deepmind/bsuite#56 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
LearningCircuit/local-deep-research#7206 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
chingu-voyages/V62-tier3-team-33#285 ·
Maintainers usually reply within 1 day