@quobix/vacuum 0.0.19 → 0.0.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -76,14 +76,14 @@ See all the documentation at https://quobix.com/vacuum
|
|
|
76
76
|
|
|
77
77
|
---
|
|
78
78
|
|
|
79
|
-
> **vacuum can suck all the lint of a 5mb OpenAPI spec in about
|
|
79
|
+
> **vacuum can suck all the lint of a 5mb OpenAPI spec in about 230ms.**
|
|
80
80
|
|
|
81
81
|
Designed to reliably lint OpenAPI specifications, **very, very quickly**. Including _very large_ ones. Spectral can be quite slow
|
|
82
82
|
when used as an API and does not scale for enterprise applications.
|
|
83
83
|
|
|
84
84
|
vacuum will tell you what is wrong with your spec, why, where and how to fix it.
|
|
85
85
|
|
|
86
|
-
vacuum will work at scale and is designed as a CLI (with a UI) and a library to be consumed in other applications.
|
|
86
|
+
vacuum will work at scale and is designed as a CLI (with a web or console UI) and a library to be consumed in other applications.
|
|
87
87
|
|
|
88
88
|
### Dashboard
|
|
89
89
|
|
|
@@ -105,7 +105,7 @@ No external dependencies, the HTML report will run completely offline.
|
|
|
105
105
|
|
|
106
106
|
> **_Supports OpenAPI Version 2 (Swagger) and Version 3+_**
|
|
107
107
|
|
|
108
|
-
You can use either **YAML** or **JSON
|
|
108
|
+
You can use either **YAML** or **JSON**, vacuum supports both formats.
|
|
109
109
|
|
|
110
110
|
AsyncAPI support is coming soon!
|
|
111
111
|
|
|
@@ -153,10 +153,6 @@ To run, just add `docker dshanley/vacuum` as your command, like so
|
|
|
153
153
|
docker dshanley/vacuum lint <your-openapi-spec.yaml>
|
|
154
154
|
```
|
|
155
155
|
|
|
156
|
-
---
|
|
157
|
-
> 👉 **Please note, the flags and commands below will change as the experience is refined.** 👈
|
|
158
|
-
---
|
|
159
|
-
|
|
160
156
|
## Build an interactive HTML report
|
|
161
157
|
|
|
162
158
|
```
|