stac-utils / stac-utils/stac-fastapi
Standardize APIRouter usage
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 324
- Forks
- 126
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 10
Description
https://github.com/stac-utils/stac-fastapi/issues/427#issuecomment-1201677603
https://github.com/stac-utils/stac-fastapi/pull/429 has a working solution for the APIRouter prefixing issue by propagating the router prefix used by the core endpoints to the rest of the application but I don't think it addresses the main issue here which is that API routers are not used or exposed in a consistent manner throughout the project.
Contributor guide
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 reviewing issue #427 and pull request #429, then inspect how APIRouter instances are used and exposed throughout the project. Determine a consistent router convention that also accounts for the core endpoint prefix. Done means the application uses and exposes API routers consistently without regressing the prefixing behavior described in the linked work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fastapi, python
- Domain
- api, backend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100