Materials-Consortia / Materials-Consortia/optimade-python-tools
Consider adding schema examples
Open
Nobody has claimed this yet.
OpenAPI
priority/low
- Dominant language
- Python
- Stars
- 91
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
Description
Example responses can be added to the OpenAPI schema using the pydantic models, the documentation for which is outlined nicely in the FastAPI documentation.
We could consider doing this.
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 with the pydantic models that generate the OpenAPI schema and consult the linked FastAPI schema-extra-example documentation. Add representative example responses to the schema; done means the generated OpenAPI schema exposes the intended examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fastapi, openapi, python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100