AlexsLemonade / AlexsLemonade/refinebio
Simplifying custom search filtering + documentation
Open
Nobody has claimed this yet.
exploration
v2
- Dominant language
- Python
- Stars
- 135
- Forks
- 21
- PR merge metrics
- No merged PRs in 30d
Description
Context
Currently we have implemented a lot of very custom filtering parameters. There are 2 main reasons why we should reconsider this implementation.
- The way you interact with each endpoint is not as consistent as it could be. This also occasionally causes bugs in terms of client implementation.
- We want to see if there is a way to remove the manual documentation and automate it with swagger or OpenAPI so that it can stay in lock step with any changes that occur.
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 by inventorying the endpoints and their current custom filtering parameters, then locate the manual documentation that describes them. Compare the inconsistencies and client-facing bugs, and define how OpenAPI-based documentation would stay synchronized; done means the filtering approach and documentation migration scope are agreed and implemented consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- api, documentation
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100