micro-contracts 0.17.18 → 0.17.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 +8 -4
- package/cli-contract.yaml +1 -1
- package/dist/micro-contracts.bundle.mjs +293 -293
- package/dist/micro-contracts.bundle.mjs.map +3 -3
- package/docs/cli-reference.md +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -205,13 +205,17 @@ project/
|
|
|
205
205
|
| Extension | Type | Description |
|
|
206
206
|
|-----------|------|-------------|
|
|
207
207
|
| `x-micro-contracts-published` | boolean | Include in `contract-published` (compatibility SLA) |
|
|
208
|
-
| `x-micro-contracts-non-exportable` | boolean |
|
|
208
|
+
| `x-micro-contracts-non-exportable` | boolean | Operation- or schema-level. Linting fails when a published endpoint can reach it (`PUBLIC_ENDPOINT_NON_EXPORTABLE`) |
|
|
209
209
|
| `x-micro-contracts-depend-on` | string[] | Explicit dependencies on other modules' published APIs |
|
|
210
210
|
| `x-private` | boolean | Schema-level. A published endpoint that can reach it fails linting (`PUBLIC_ENDPOINT_PRIVATE_RESPONSE`) |
|
|
211
211
|
|
|
212
|
-
"Can reach it" covers every way one schema refers to another
|
|
213
|
-
items, `additionalProperties`, `allOf`/`oneOf`/`anyOf`,
|
|
214
|
-
|
|
212
|
+
"Can reach it" covers every way one schema refers to another (properties, array
|
|
213
|
+
items, `additionalProperties`, `allOf`/`oneOf`/`anyOf`, `$ref` targets) and every
|
|
214
|
+
part of an operation that reaches a schema: request bodies, parameters and
|
|
215
|
+
responses of any status code, including through `components.requestBodies`,
|
|
216
|
+
`components.parameters` and `components.responses`. `contract-published` contains
|
|
217
|
+
exactly what that same reachability finds, so nothing can ship unchecked. The same
|
|
218
|
+
reachability enforces `x-micro-contracts-non-exportable`.
|
|
215
219
|
|
|
216
220
|
### Screen Spec Extensions
|
|
217
221
|
|
package/cli-contract.yaml
CHANGED