Annotate response model for all endpoints
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 22
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
We should mirror what we now do over in the BEDbase UI with auto-gen of TypeScript types for development. This requires that all endpoints are annotated with a response_model object, I believe.
Then we can add a package.json script to generate the types and switch over our queries to use that for response model annotation.
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
Review the BEDbase UI approach referenced in the issue, then inspect the API endpoint definitions, package.json, and query code. Determine which endpoints lack response_model annotations and how the existing type-generation flow is configured. Done means all endpoints are covered, a package.json generation script exists, and queries use the generated response types.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, backend, developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100