specshield 3.4.17 → 3.5.0
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/CHANGELOG.md +11 -9
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
# SpecShield CLI changelog
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## 3.5.0 — 2026-10-29 — gate, fix, safe removal
|
|
4
4
|
|
|
5
|
-
###
|
|
5
|
+
### A gate teams can leave blocking: `specshield gate`
|
|
6
|
+
|
|
7
|
+
#### Added
|
|
6
8
|
|
|
7
9
|
- **`specshield gate [spec]`** — the CI check. Compares the spec with the merge base of
|
|
8
10
|
the branch (never the base branch's tip or production), so changes merged since the
|
|
@@ -20,7 +22,7 @@
|
|
|
20
22
|
headline ("Would have blocked 3 PRs — all 3 were real breaks. Safe to turn on blocking.").
|
|
21
23
|
- `gate.*` keys in `.specshield.yml`; `--usage` works as in `compare`.
|
|
22
24
|
|
|
23
|
-
|
|
25
|
+
#### Tested on real data
|
|
24
26
|
|
|
25
27
|
- Redocly/museum-openapi-example PR #18 (open, far behind `main`), depth-1 checkout from
|
|
26
28
|
GitHub: comparing with `main`'s tip reports 14 breaking changes, all from commits merged
|
|
@@ -28,9 +30,9 @@
|
|
|
28
30
|
HTTPS in ~1 s and reported 0.
|
|
29
31
|
|
|
30
32
|
|
|
31
|
-
|
|
33
|
+
### Break → fix: `specshield fix`
|
|
32
34
|
|
|
33
|
-
|
|
35
|
+
#### Added
|
|
34
36
|
|
|
35
37
|
- **`specshield fix <base> <target>`** writes the non-breaking version of a breaking
|
|
36
38
|
change as minimal edits to the target spec (comments and layout kept): renamed fields
|
|
@@ -46,7 +48,7 @@
|
|
|
46
48
|
- `compare` points at `specshield fix` when it finds breaking changes.
|
|
47
49
|
- `specshield deprecations` also honours `x-deprecated: true` (Swagger 2.0 schemas).
|
|
48
50
|
|
|
49
|
-
|
|
51
|
+
#### Tested on real data
|
|
50
52
|
|
|
51
53
|
- Kubernetes `swagger.json` v1.37.1 → master: 552 breaking changes, all fixed and verified
|
|
52
54
|
(7 s); an independent `compare` of v1.37.1 against the fixed spec reports 0.
|
|
@@ -57,9 +59,9 @@
|
|
|
57
59
|
between single-value constants of `oneOf` variants that moved. A format-only change
|
|
58
60
|
(`integer` → `int64`) no longer suggests a new field.
|
|
59
61
|
|
|
60
|
-
|
|
62
|
+
### Safe removal: deprecate → watch traffic drain → remove
|
|
61
63
|
|
|
62
|
-
|
|
64
|
+
#### Added
|
|
63
65
|
|
|
64
66
|
- **`specshield deprecations <spec> --usage usage.json`** lists everything the spec marks
|
|
65
67
|
`deprecated: true` (or gives an `x-sunset` date) — operations, parameters, request and
|
|
@@ -76,7 +78,7 @@
|
|
|
76
78
|
- `usage import` records calls per week per client and when each query parameter was last
|
|
77
79
|
sent (additive `weeks` / `paramsLastSeen` in usage.json; older files still load).
|
|
78
80
|
|
|
79
|
-
|
|
81
|
+
#### Tested on real data
|
|
80
82
|
|
|
81
83
|
Kubernetes' published CI audit log (106,445 requests) against the official
|
|
82
84
|
`swagger.json`, with the upstream deprecations marked (the `v1 Endpoints` API, deprecated
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "specshield",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.5.0",
|
|
4
4
|
"description": "Contract compatibility testing for APIs — catch breaking OpenAPI changes before they reach your consumers, with can-i-deploy deploy gating and GitHub PR checks. (a.k.a. bidirectional contract testing.)",
|
|
5
5
|
"main": "src/cli.js",
|
|
6
6
|
"homepage": "https://specshield.io",
|