PolicyEngine / PolicyEngine/policyengine-api
Add OpenAPI request examples and generate an importable Postman collection
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 18
- Forks
- 33
- Avg merge
- 23h 40m
- Merged PRs (30d)
- 22
Description
Based on a question/suggestion from @SonaliBedge. If we had a collection that we could point to, onboarding new API developers would be much quicker.
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 the API's OpenAPI description and the request shapes it exposes, then determine how those examples should be represented for Postman import. Done means the relevant OpenAPI requests have usable examples and an importable Postman collection is available for onboarding API developers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, postman, python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100