Before v0.12

All core functions returned the same path provided in the rule. This is because there was no way to determine the actual path due to limitations in some core dependencies.

This is explained here: #269 and was recently revived here: #527

After v0.12

All core functions now return the correct JSON path for all results. This is now possible because of two supporting library upgrades
that we control has facilitated this possibility, without depending on any upstream libs we don't control.

For example, the following ruleset:

rules:
  description-is-coffee:
    description: "check that every description is 'coffee'"
    given: $..description
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "^coffee$"
  every-response-has-schema:
    description: "check that every media type for 200 response has a made up field called peanuts"
    given: $.paths.*.*.responses.200.content.*
    severity: error
    then:
      field: peanuts
      function: truthy

When run with the model/test_files/burgershop.openapi.yaml sample spec, results in output like this:

vacuum lint model/test_files/burgershop.openapi.yaml -r ruleset.yaml -d -m

However, now in v0.12+ the same command (and using the new --no-clip command) shows the actual path.

vacuum lint model/test_files/burgershop.openapi.yaml -r ruleset.yaml -d -m --no-clip

Changelog

• e4a8a9d Added —no-clip flag to lint command
• ca4b96e Addressed #519
• 3877e4e Updated core rules to use new doctor feature
• f1611c6 bumped deps
• c294c47 no clip added
• 879e1ca readme
• 04a3498 tuned example check,
• 29bd84c updated readme.
• 59b3a17 updated to use correct chars