PolicyEngine / PolicyEngine/policyengine-sim-api
Investigate alternatives to the current OpenAPI client generator
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1
- Forks
- 1
- Avg merge
- 10h 29m
- Merged PRs (30d)
- 7
Description
This is follow up of issue #205 / PR #210
Current OpenAPI client is cumbersome to use (not OO, awkward structure, returns unions instead of throwing exceptions).
Explore and evaluate alternative Python OpenAPI client generators for a more maintainable and user-friendly API client.
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 reading issue #205 and PR #210 to understand the current OpenAPI client and its known usability problems. Evaluate Python OpenAPI client generators against the stated object-oriented API, error handling, and maintainability goals. Done means documenting the alternatives and a justified recommendation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100