v0.8.5

New Feature

Added two new flags to the lint command that allow varying control over how circular references are handled by vacuum.

• --ignore-polymorph-circle-ref
• --ignore-array-circle-ref

These two new flags will ignore array based or polymorphic circular references when running the lint command.

Documentation for lint command

Contributed by @eli-l

Changelog

• ca547af Add ignore-polymorph-circle-ref flag to lint command.
• 95d2349 Add lint flag to allow ignore circular references in arrays.
• 96f4433 Ignore circular polymorphic ref.
• 62d8842 Make it tidy
• e29001f Upgrade github.com/pb33f/libopenapi to v0.15.2

v0.8.4

Changelog

• 4491f4b Add nil check for required properties

v0.8.3

Changelog

• 2fffb5c Added nil checks around OWASP rules
• 0e30ba4 Addressed issues #428 and #424

v0.8.2

Changelog

• fadb7ee Added openapi 3.1 null type
• 3330e3a Added test for openapi 3.1 null type

v0.8.1

Changelog

• 0e71f2f Addresses #424 and #423
• ff22a46 updated test

v0.8.0

Contains fixes for the following issues:

• #417 Fixed length function issues
• #411 invalid types are now detected by the new oas-schema-check rule
• #368 New bundle command available

Windows support

With libopenapi v0.15 vacuum now correctly operates on windows when using external references on the file system.

New spec bundling feature

There is a new command bundle in vacuum. It will bundle an exploded specification (spec with external references) to be bundled into a single file. All external references will be inlined and bundled into a single file (#368)

New rule oas-schema-check

Resolving issue #411, a new rule has been added to the built-in ruleset called oas-schema-check. This rule will not validate schemas, but it will check them for basic validation problems that are not caught by the existing validation rules.

oas-schema-check documentation

Changelog

• 58fab1e Added new function and rule schema-type-check
• 90ac933 Added new ‘bundle’ command
• 6fd23f0 Addressed issue #417
• 47949ab Cleaned up path rendering
• 79e7a11 bumped deps on the doctor
• ecc3111 fixed linting issue
• 25665d6 re-bumped deps
• 262d4e3 re-enabled node search path logic
• c7a4f74 updated dependencies
• 7062757 updated docs links in readme.
• 3b806c5 updated readme.

v0.7.2

Changelog

• ffe5198 Circular ref check was not happening before model build.
• 931a1e1 bumped version of libopenapi

v0.7.1

Changelog

• 17f3af3 I thought I was in vim for some reason.
• 61b63de bumped dependencies
• e908e72 resolved panic reported in #412

v0.7.0

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

Changelog

• 5cd70e2 Added hard mode -z turns on EVERTHING
• eb8ceee Added property support to all OWASP functions.
• 9f960d8 Another sweep through to clean up
• cfd43ea Cleaned up readme and error
• f48c65f Rebuilding OpenAPI functions
• 19529aa Tuned exising tests, removed swagger variations
• 5fee442 Update README.md
• 70c08a4 Updated against new doctor API
• f641668 cleaned up linting
• b4bfa82 cleaning things up, polish and more.
• ba19914 completed OWASP upgrade
• be5143e examples function is now mostly rebuilt.
• e813f0d html-report only shows categories with results #399
• 19b4bb9 lots of OWASP function building.
• ed1f099 quick tidy up
• f537f20 removing JSON parsing channel after cleanup.
• 7aab2ff replaced old examples code, extracted rules into multiple functions. #403
• c4adbe2 updated to latest libopenapi
• 79ab746 working through OWASP rebuild.

v0.6.3

Changelog

• 17468ea Added timeout feature to prevent runaway linting
• 431ac35 Fixed zuplo link
• 40f3484 fixed go.mod