@superjackfruitlabs/treaty-event-schemas 0.0.13 → 0.0.15
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/package.json +1 -1
- package/schemas/README.md +20 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@superjackfruitlabs/treaty-event-schemas",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.15",
|
|
4
4
|
"description": "JSON Schemas for the events Super Jackfruit Labs products send, and the catalogue that names their CloudEvents types.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
package/schemas/README.md
CHANGED
|
@@ -1,3 +1,16 @@
|
|
|
1
|
+
# Schemas
|
|
2
|
+
|
|
3
|
+
Every contract treaty holds, as JSON Schema draft 2020-12. Each schema's `$id` is its address on
|
|
4
|
+
the public repository, and every schema belongs to a crossing in
|
|
5
|
+
[`contracts/registry.json`](../contracts/registry.json).
|
|
6
|
+
|
|
7
|
+
- `common/`: pieces other contracts reference, such as `error.v1.json`, the one error envelope.
|
|
8
|
+
- `http/`: HTTP APIs as OpenAPI 3.1 documents ([conventions](http/README.md)).
|
|
9
|
+
- `treaty/`: the shape of treaty's own files: the registry, the error codes and a product's
|
|
10
|
+
`treaty.json`.
|
|
11
|
+
|
|
12
|
+
The sections below describe the event and Matrix schemas.
|
|
13
|
+
|
|
1
14
|
# Event schemas
|
|
2
15
|
|
|
3
16
|
JSON Schemas (draft 2020-12) for the bodies suite products send, as plain data. `catalog.json`
|
|
@@ -66,3 +79,10 @@ TypeScript that builds and reads them.
|
|
|
66
79
|
`scripts/matrix-examples.ts` from `fixtures/ecosystem-identity/matrix_gate_events.json` and from
|
|
67
80
|
this package's builders. Each invalid case says what refuses it: the schema, a uniqueness rule, or
|
|
68
81
|
only the carrier, against what it recorded when it posted.
|
|
82
|
+
|
|
83
|
+
## SuperBench local operations (`superbench/`)
|
|
84
|
+
|
|
85
|
+
`operation.v1.json` describes the local Unix-peer operator API, not an event.
|
|
86
|
+
Its corpus is `fixtures/superbench-api/operations.json`; the transport/authority
|
|
87
|
+
contract is [the local API proposal](../docs/2026-11-14-superbench-local-api.md).
|
|
88
|
+
No CloudEvents catalogue entry or remote token audience is implied.
|