square / square/connect-api-specification
OpenAPI Generator Spec fails validation on divergent OpenAPI fork
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 76
- Forks
- 36
- Avg merge
- 3h 14m
- Merged PRs (30d)
- 1
Description
OpenAPI v3 has a very commonly used fork including many languages not supported by Swagger's version of OpenAPI v3. The API spec for Square fails to validate for OpenAPI Generator due to the following issues:
- attribute components.schemas.CatalogModifierOverride.CatalogModifierToggleOverrideType is not of type
schema - paths.'/v2/vendors/{vendor_id}'. Declared path parameter vendor_id needs to be defined as a path parameter in path or operation level
- attribute info.externalDocs is unexpected
These can be fixed by the following changes:
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
Locate the Square API specification entries for CatalogModifierOverride.CatalogModifierToggleOverrideType, the /v2/vendors/{vendor_id} path, and info.externalDocs. Run OpenAPI Generator validation against the spec and compare the reported errors with the three requested corrections. Done means the specification passes validation without these errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 63/100