@quobix/vacuum 0.22.0 → 0.23.1
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 +33 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -133,7 +133,37 @@ come say hi!
|
|
|
133
133
|
|
|
134
134
|
## Documentation
|
|
135
135
|
|
|
136
|
-
🔥 **New in** `v0.
|
|
136
|
+
🔥 **New in** `v0.23` 🔥: **OpenAPI Overlay Support**
|
|
137
|
+
|
|
138
|
+
Ever needed to tweak an OpenAPI spec for different environments without maintaining multiple copies?
|
|
139
|
+
|
|
140
|
+
Maybe swap out server URLs between dev, staging, and production? Or perhaps strip out internal endpoints before publishing the API docs?
|
|
141
|
+
|
|
142
|
+
OpenAPI Overlays are the answer. They let us make non-destructive modifications to specs using JSONPath expressions to
|
|
143
|
+
target exactly what we want to change. vaccum now supports a new `apply-overlay` command.
|
|
144
|
+
|
|
145
|
+
- [Learn more about the apply-overlay command](https://quobix.com/vacuum/commands/apply-overlay)
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
`v0.22`: **Async Functions / Promises, Fetch & Batch mode in Custom JS Functions**
|
|
151
|
+
|
|
152
|
+
Do you want to call remote APIs in your vacuum javascript functions? What about async processing or the ability to use Promises?
|
|
153
|
+
|
|
154
|
+
vacuum now has its own event loop and will happily support `async` and `await`. Combined with a full implementation of [Fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
|
|
155
|
+
|
|
156
|
+
Also added **Batch Mode**. This allows custom functions to receive the entire list of nodes, instead of firing the function
|
|
157
|
+
for each result, so you can send all your data off to an API or an LLM, and have the ability parse and process everything at once
|
|
158
|
+
vs individually.
|
|
159
|
+
|
|
160
|
+
- [Read all about async JS functions in vacuum](https://quobix.com/vacuum/api/custom-javascript-functions/#async-functions--promises)
|
|
161
|
+
- [Learn about using fetch in vacuum](https://quobix.com/vacuum/api/custom-javascript-functions/#fetch-api)
|
|
162
|
+
- [find out how batch mode works](https://quobix.com/vacuum/api/custom-javascript-functions/#batch-mode-processing)
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
`v0.21`: **Change detection filtering**
|
|
137
167
|
|
|
138
168
|
Want to see linting results on **just** the changes you have made to an OpenAPI document? Or want to see just the results on the differences between two documents?
|
|
139
169
|
comes with a **what changed** mode. Using the new `--original` and `--changes-summary` global flags, you can filter out all the noise.
|
|
@@ -232,7 +262,8 @@ See all the documentation at https://quobix.com/vacuum
|
|
|
232
262
|
- [bundle](https://quobix.com/vacuum/commands/bundle/)
|
|
233
263
|
- [spectral-report](https://quobix.com/vacuum/commands/spectral-report/)
|
|
234
264
|
- [language-server](https://quobix.com/vacuum/commands/language-server/)
|
|
235
|
-
- [
|
|
265
|
+
- [apply-overlay](https://quobix.com/vacuum/commands/apply-overlay/)
|
|
266
|
+
- [Change Detection](https://quobix.com/vacuum/commands/change-detection/)
|
|
236
267
|
- [Developer API](https://quobix.com/vacuum/api/getting-started/)
|
|
237
268
|
- [Using The Index](https://quobix.com/vacuum/api/spec-index/)
|
|
238
269
|
- [RuleResultSet](https://quobix.com/vacuum/api/rule-resultset/)
|