@mitre/hdf-openapi 3.8.0-next.43322455428.1 → 3.8.0-next.43464690672.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 +5 -5
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -100,14 +100,14 @@ Every other definition is hoisted to `#/components/schemas/<Name>` under its own
|
|
|
100
100
|
- **Whether each generator can consume the document at all.** `openapi-typescript` can. **`oapi-codegen` 2.8.0 cannot:** its parser (kin-openapi) rejects a boolean subschema, which HDF uses to express the three-tier BOM rule (`properties: { model: false }` on a non-`ai-model` BOM). The refusal and its trigger are recorded rather than worked around, because the construct is a real constraint and dropping it would weaken the schema to suit one tool.
|
|
101
101
|
- **Per keyword, whether a generator's output depends on it** — measured differentially: generate from a probe schema carrying the keyword, generate again with that one keyword deleted, compare the bytes. Both generators honour the structural keywords (`$ref`, `properties`, `required`, `items`, `type`, `enum`, `allOf`/`anyOf`/`oneOf`, `format`) and **both discard every validation constraint**: `minimum`, `maximum`, `minLength`, `minItems`, `pattern`, `contains`, `not`, `dependentRequired`, `if`/`then`/`else` and `unevaluatedProperties`. Generated types are shape-only. Anything that must actually enforce the schema has to run a validator — which is why ADR-0008 §7 derives Zod from this document rather than trusting generated types.
|
|
102
102
|
|
|
103
|
-
None of that is optional. `pnpm test` re-measures the lints and openapi-typescript and fails on any drift from the baseline, and CI's `check-openapi-matrix` job installs
|
|
103
|
+
None of that is optional. `pnpm test` re-measures the lints and openapi-typescript and fails on any drift from the baseline, and CI's `check-openapi-matrix` job installs `oapi-codegen` at the version `mise.toml` pins and runs the full matrix, so the Go half is gated too. The test also asserts that CI wiring still exists — an ungated baseline is the real hazard, so losing the job fails the suite rather than quietly going unmeasured.
|
|
104
104
|
|
|
105
|
-
`oapi-codegen` is a Go binary, not an npm dependency, which is why `pnpm test` measures only the half it can reach. To run the whole matrix locally:
|
|
105
|
+
`oapi-codegen` is a Go binary, not an npm dependency, which is why `pnpm test` measures only the half it can reach. `mise.toml` at the repository root pins it at the version the baseline records, and `mise install` installs that release. Run the matrix under `mise exec --` (or with mise activated in your shell) so that release, not another `oapi-codegen` on PATH, is the one measured. To run the whole matrix locally:
|
|
106
106
|
|
|
107
107
|
```bash
|
|
108
|
-
|
|
109
|
-
pnpm run matrix
|
|
110
|
-
pnpm run matrix:update
|
|
108
|
+
mise install # oapi-codegen at the pinned version, with the rest of the toolchain
|
|
109
|
+
mise exec -- pnpm run matrix # verify against the tracked baseline
|
|
110
|
+
mise exec -- pnpm run matrix:update # re-record after a deliberate tooling or schema change
|
|
111
111
|
pnpm run lint:openapi # Redocly alone
|
|
112
112
|
```
|
|
113
113
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mitre/hdf-openapi",
|
|
3
|
-
"version": "3.8.0-next.
|
|
3
|
+
"version": "3.8.0-next.43464690672.1",
|
|
4
4
|
"description": "OpenAPI 3.1 components for HDF, generated from the HDF JSON Schema 2020-12 bundles",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"openapi-typescript": "^7.13.0",
|
|
37
37
|
"tsx": "^4.20.6",
|
|
38
38
|
"yaml": "^2.8.1",
|
|
39
|
-
"@mitre/hdf-fixtures": "^3.8.0-next.
|
|
39
|
+
"@mitre/hdf-fixtures": "^3.8.0-next.43464690672.1"
|
|
40
40
|
},
|
|
41
41
|
"engines": {
|
|
42
42
|
"node": ">=24.0.0"
|