HackIllinois / HackIllinois/adonix
Confusing Endpoints
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
The overall GET / implies that this gets overall registration status, but this does not include drafts. Even if we have two collections under the hood (which we shouldn't but that's a different discussion), callers should not have to choose which collection to pull from. Maybe return something like:
{
submitted: True,
data: ...
}
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 at src/services/registration/registration-router.ts around lines 66–126 and trace the GET / endpoint's registration-status response. Confirm how submitted registrations and drafts are currently handled, then define the response behavior so callers do not need to choose between collections. Done means GET / communicates overall registration status and includes drafts consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100