Change linting of openapi property to allow OAS 3.2.0
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 146
- Forks
- 49
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 11
Description
We've made no changes to our OAS YAML file other than updating the openapi version to 3.2.0. There are no breaking changes in this version of OAS so there is no reason it should not work, but we get this error when trying to push the docs up to readme via the CLI tool:
OpenAPI schema validation failed.
PROPERTY must match pattern "^3\.0\.\d(-.+)?$"
1 | {
> 2 | "openapi": "3.2.0",
| ^^^^^^^^^ must match pattern ^3\.0\.\d(-.+)?$
3 | "info": {
4 | "title": "Routable API",
5 | "version": "2022-01-12",
Please update this regex in your next version to allow 3.2.0 files to be passed.
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
Search the CLI's OpenAPI validation logic for the regex ^3\.0\.\d(-.+)?$ shown in the error. Reproduce the failure with the supplied OAS YAML or an equivalent document, update the validation rule, and confirm that an OAS 3.2.0 file can be pushed through the CLI without this error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, openapi
- Domain
- api, cli
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100