fluid-core/conformance/fixtures/README.md

29 lines
1.3 KiB
Markdown
Raw Normal View History

# Schema fixtures
Every file here is transcribed from a worked example in `spec/`. They exist so
that a change to the specification which is not reflected in `schemas/` fails
the build.
Two deviations from the spec text are deliberate and are the only ones allowed:
1. **Placeholder digests.** The spec writes `sha256:<digest>`. Fixtures use a
syntactically valid digest, because the schema constrains the format.
2. **Placeholder artifact paths.** The spec writes `contractRef: ...`. Fixtures
use a plausible reference.
Anything else that differs from the spec is a bug in the fixture or in the
schema, not a licence to relax the schema.
| Fixture | Source |
|---|---|
| `hypothesis.yaml` | `FluidHypothesisRevisionSchema.md` §3 |
| `revision.yaml` | `FluidHypothesisRevisionSchema.md` §8 |
| `experiment.yaml` | `FluidHypothesisRevisionSchema.md` §12 |
| `pressure.yaml` | `FluidHypothesisRevisionSchema.md` §13 |
| `backend-requirement.yaml` | `FluidHypothesisRevisionSchema.md` §14 |
| `event.yaml` | `FluidHypothesisRevisionSchema.md` §15 |
| `revision-descriptor.yaml` | `ArchitectureBlueprint.md` §36 |
| `routing-policy.yaml` | `ArchitectureBlueprint.md` §17 |
| `feedback.yaml` | `FluidAPIStandards.md` §15, `ArchitectureBlueprint.md` §38 |
| `telemetry-envelope.yaml` | `ArchitectureBlueprint.md` §6.1 |