leigh-hackspace / leigh-hackspace/hackspace-api
Improve Endpoint Documentation
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Documentation is available at https://api.leighhack.org/docs but only has the basics. We need to extend them out to describe what each endpoint does.
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 linked API documentation at https://api.leighhack.org/docs and inspect the FastAPI endpoint definitions to identify what is currently documented. Extend the endpoint documentation so each endpoint’s purpose is described, then verify the published docs cover every endpoint.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fastapi, python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100