report command will generate a high fidelity recording of a linting run. The report is a replayable
data set that can be used to re-render any vacuum report using either the
dashboard, or the html-report
The original results are preserved and won’t be changed, regardless how many times the report is re-rendered.
This will generate a report from your my-openapi-spec.yaml and will save the file as myreport-MM-DD-YY-HH-MM-SS.json
You can save these reports and replay them when ever you want, soon you will be able to replay multiple reports, over time!
Compression is best
One thing that I highly recommend, is using compression with vacuum reports. It’s all automatic, all that is required
is to pass the
The compressed file is significantly smaller than the original specification, tiny really.
When re-playing a compressed report, vacuum will automatically detect that it’s compressed, and unpack things.
This will generate a compressed report from your my-openapi-spec.yaml and will save the file as myreport-MM-DD-YY-HH-MM-SS.json.gz.
JUnit XML Support
Are you using Jenkins or some other CI that supports JUnit XML reports? vacuum can generate a JUnit XML report instead of a vacuum format JSON report.
--junit flag can be used to generate a JUnit XML report instead of a vacuum format JSON report.
report supports the following flags
||Compress the report with gzip (recommended)|
||Render a machine-only version (can’t be used with
||Show help screen and all flag details|
||Disable color and style console output (useful for CI/CD)|
||Render a JUnit XML report|
report supports the following global flags
||Use an existing ruleset file for linting|
||Show how long vacuum took to run (ms)|
||Base URL or Base working directory to use for relative references|
||Load remote references automatically if possible (default is true)|
||Skip checking for a valid OpenAPI document, useful for linting fragments or non-OpenAPI documents|
Full flags begin with a double hyphen.
Want something easy to copy and paste?
Optimized for machines, without compression
Use an existing RuleSet with compression
Use stdin and stdout
Here is an example of how to use
stdout with the
report command, and pipe
the output to
Reports can be replayed through the following commands: