feat: adding support for OpenAPI 3.1 #378
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
erunion
commented
Dec 2, 2021
| @@ -68,36 +68,7 @@ describe('rdme openapi', () => { | |||
| }); | |||
| }); | |||
|
|
|||
| it('should error if API errors', () => { | |||
There was a problem hiding this comment.
There's a whole bunch of nits like this in this changeset but the gist of what I did in this file are:
- Move errors into an "error handling" describe.
- Fix some confusing
itlanguage. - Add some tests to make sure that errors that are coming back from
oas-normalize(and@readme/openapi-parser) are of the new format. - Use specs that we have in
@readme/oas-examples. - Add tests for JSON and YAML definitions.
erunion
commented
Dec 2, 2021
| const oas = new OASNormalize(specPath, { enablePaths: true }); | ||
| await oas.validate().catch(err => { | ||
| const oas = new OASNormalize(specPath, { colorizeErrors: true, enablePaths: true }); | ||
| await oas.validate(false, { validate: { colorizeErrors: true } }).catch(err => { |
There was a problem hiding this comment.
This option controls the pretty errors that'll be shown. If colorizeErrors is false (it's false by default) those errors will still look nice they just won't have colors or bold text.
erunion
requested review from
a team,
Dashron and
julshotal
and removed request for
a team
Dashron
approved these changes
Dec 2, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧰 Changes
oasto support OpenAPI 3.1 within itsrdme oas generatecommand for generating API definitions.Fixes RM-1813
🧬 QA & Testing
See tests.