Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v0.7.0 #408

Merged
merged 18 commits into from
Jan 5, 2024
Merged

v0.7.0 #408

merged 18 commits into from
Jan 5, 2024

Conversation

daveshanley
Copy link
Owner

@daveshanley daveshanley commented Jan 4, 2024

v0.7.0 introduces a complete rebuild of the OWASP rule functions. They have now all been moved into custom functions. This was done because the previous rules were choking at scale, and all the paths were undecipherable.

This update should address issue #398

view OWASP functions

  • All paths provided by all built in rules are now complete and detailed.
  • OWASP rules run much, much faster and have more detailed reporting and no duplicate errors.

Example functions re-written.

The examples functionality have all been rewritten. They now run much faster and are much more accurate. They have also been broken down into three rules, from the previous one.

Modified rule: oas3-valid-schema-example

This rule now ONLY checks that schemas provided by examples are valid.

New rule: oas3-missing-example

view docs

This rule checks to ensure all Schemas, Parameters, Headers and Media Types have an examples or example field set,
and ensures that no empty values are provided.

New rule: oas3-example-external-check

view docs

This rule checks that no examples in Parameters, Headers and Media Types have used both an externalValue and a value property.

These modifications address #403 and #392

New feature 'Hard Mode'

All commands support the new -z / --hard-mode flag. This will enable every built-in rule in vacuum. This is the highest level of compliance available built into vacuum.

If you want to really test your OpenAPI spec, then try Hard Mode, and then feel sad.

Fixed spectral-report paths

Issues #295 and #304 have been addressed with the path cleanup work.

Dashboard and html-report updates

Only categories that triggered results are available in reports and the terminal UI now. #399

everything needs an update, starting with the most noisy.

Signed-off-by: quobix <[email protected]>
Signed-off-by: quobix <[email protected]>
corrected some errors and cleaned things up in general, without changing any of the logic / outcomes.

Signed-off-by: quobix <[email protected]>
a simpler design, better DX.

Signed-off-by: quobix <[email protected]>
Finally, it’s time. After all this time - I can rebuild the way it was supposed to be.

Signed-off-by: quobix <[email protected]>
stops confusion and completes

Signed-off-by: quobix <[email protected]>
Think your spec can pass it? Hah.. try it.

Signed-off-by: quobix <[email protected]>
Signed-off-by: quobix <[email protected]>
@daveshanley daveshanley merged commit cfd43ea into main Jan 5, 2024
6 checks passed
@daveshanley daveshanley deleted the v0.7.0 branch January 5, 2024 02:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant