ProjectTech4DevAI / ProjectTech4DevAI/kaapi-guardrails
Standardize request handlers, esp exception handling
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 3
- Avg merge
- 9d 13h
- Merged PRs (30d)
- 2
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.
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
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.
Assessment
- Tech stack
- python
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100