chore: improve OAS functions #1362
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
P0lip
force-pushed
the
feat/oas-functions
branch
from
d90a572
to
9cd48d4
Compare
P0lip
force-pushed
the
feat/oas-functions
branch
from
9cd48d4
to
f51a6b0
Compare
philsturgeon
previously approved these changes
Nov 30, 2020
P0lip
force-pushed
the
feat/oas-functions
branch
from
177d3ab
to
87e4a7a
Compare
P0lip
added a commit
that referenced
this pull request
Jan 4, 2021
* chore: improve OAS functions * fix: check for presence of operationId
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.
Fixes
spectral lint a.yaml OpenAPI 3.x detected TypeError: Cannot convert undefined or null to object at Function.keys (<anonymous>) at Object.oasOpIdUnique (eval at <anonymous> (/snapshot/spectral/dist/rulesets/evaluators.js:89:80), <anonymous>:1:352) at Object.lintNode (/snapshot/spectral/dist/runner/lintNode.js:30:33) at runRule (/snapshot/spectral/dist/runner/runner.js:27:24) at Runner.run (/snapshot/spectral/dist/runner/runner.js:98:17) at Spectral.runWithResolved (/snapshot/spectral/dist/spectral.js:101:22) at async Spectral.run (/snapshot/spectral/dist/spectral.js:113:17) at async Object.lint (/snapshot/spectral/dist/cli/services/linter/linter.js:50:26) TypeError: Cannot convert undefined or null to object at Function.keys (<anonymous>) at Object.oasTagDefined (eval at <anonymous> (/snapshot/spectral/dist/rulesets/evaluators.js:89:80), <anonymous>:1:440) at Object.lintNode (/snapshot/spectral/dist/runner/lintNode.js:30:33) at runRule (/snapshot/spectral/dist/runner/runner.js:27:24) at Runner.run (/snapshot/spectral/dist/runner/runner.js:98:17) at Spectral.runWithResolved (/snapshot/spectral/dist/spectral.js:101:22) at async Spectral.run (/snapshot/spectral/dist/spectral.js:113:17) at async Object.lint (/snapshot/spectral/dist/cli/services/linter/linter.js:50:26) TypeError: Cannot convert undefined or null to object at Function.keys (<anonymous>) at Object.oasOpSecurityDefined (eval at <anonymous> (/snapshot/spectral/dist/rulesets/evaluators.js:89:80), <anonymous>:1:6084) at Object.lintNode (/snapshot/spectral/dist/runner/lintNode.js:30:33) at runRule (/snapshot/spectral/dist/runner/runner.js:27:24) at Runner.run (/snapshot/spectral/dist/runner/runner.js:98:17) at Spectral.runWithResolved (/snapshot/spectral/dist/spectral.js:101:22) at async Spectral.run (/snapshot/spectral/dist/spectral.js:113:17) at async Object.lint (/snapshot/spectral/dist/cli/services/linter/linter.js:50:26) /foo/path/a.yaml 1:1 warning info-contact Info object should contain `contact` object. 1:1 warning info-description OpenAPI object info `description` must be present and non-empty string. 1:1 warning oas3-api-servers OpenAPI `servers` must be present and non-empty array. 1:1 error oas3-schema Object should have required property `info`. 1:1 warning openapi-tags OpenAPI object should have non-empty `tags` array. 3:8 error oas3-schema `~1foo` property type should be object. ✖ 6 problems (2 errors, 4 warnings, 0 infos, 0 hints)that was yield for the following document (nullish path)
Other than that, I also assured that most of our OAS functions actually validate valid operations.
This wasn't the case for some of them.
Last but not least,
oasOpIdUniquereports errors only for 2nd and all subsequent duplicate keys.The first one is not considered an error.
Checklist
Does this PR introduce a breaking change?