OpenAPITools / OpenAPITools/openapi-generator
Revise Petstore spec
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Description
The Petstore spec (json/yaml, 2.0/30) was obtained a while ago but it may not be perfectly and accurately describing the Petstore API so we may need to revise it to ensure it correctly describes the API.
openapi-generator version
Latest version
OpenAPI declaration file content or url
- https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml
- https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml
- https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml
- https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml
and other generator-specified spec/docs
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 four Petstore files under modules/openapi-generator/src/test/resources/2_0 and 3_0, then review the other generator-specified specs and documentation mentioned in the issue. Compare their descriptions with the Petstore API; done means the referenced specifications accurately describe the API across the listed OpenAPI versions and formats.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100