ashrafee-dev / ashrafee-dev/scamshield-api
Add a readiness check for external services
Open
Nobody has claimed this yet.
good first issue
- Dominant language
- Python
- Stars
- 3
- Forks
- 10
- Avg merge
- 14h 44m
- Merged PRs (30d)
- 9
Description
Goal
Distinguish a running process from an API instance that can actually analyze requests.
Acceptance criteria
- Add a readiness endpoint or documented readiness behavior separate from the liveness check.
- Define how Redis, the API key, and audio dependencies are handled.
- Avoid making expensive DeepSeek or Whisper calls on every probe.
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 by locating the existing liveness check and the code that configures Redis, the API key, and audio dependencies. Decide and document how each dependency affects readiness, while ensuring probes do not invoke expensive DeepSeek or Whisper calls. Done means a separate readiness endpoint or clearly documented readiness behavior meets all listed acceptance criteria.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fastapi, python
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100