OpenCloning / OpenCloning/OpenCloning_backend
Add example requests for the API docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8
- Forks
- 11
- Avg merge
- 14m
- Merged PRs (30d)
- 5
Description
It would be nice to add some minimal example requests to the API documentation. The ones that require inputs, those inputs can be really short, like 10 basepairs long for a digestion, or whatever. I wonder if there is a way to write those examples in files and use them both as examples for the API and for the tests.
- example for
genebank_id - example for
restriction - example for
ligation
The documentation for providing examples in FastAPI is here
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 the API documentation and the FastAPI examples guidance linked in the issue, then locate the endpoints for genebank_id, restriction, and ligation. Add minimal example requests, using short inputs where needed, and verify whether the examples can also serve the corresponding tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fastapi, python
- Domain
- api, documentation, testing
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100