Legislation · public publication pilot
frl-caveats: schema and stability
Generated reference for this publication’s exact JSON Schema sidecar. Field constraints below come directly from the sidecar; JSON Schema does not reproduce every Effect refinement.
Published stability metadata
- Schema version
- 1.0.0
- Digest meaning
- exact-file-bytes
- Empty file meaning
- valid-empty-file
- Additive changes
- enum-value-added, field-added, record-added
- Breaking changes
- contract-digest-changed, digest-framing-changed, enum-value-removed, field-removed, path-pattern-changed, record-changed, record-removed, schema-digest-changed
Identifier stability rules
[
{
"identifierName": "caveatId",
"mechanicalInputs": "slug, version date, artifact path, and structural path",
"stabilityRule": "stable-while-structural-inputs-stable",
"uniquenessScope": "slug-version"
},
{
"identifierName": "slug",
"mechanicalInputs": "source descriptor slug",
"stabilityRule": "stable-while-source-descriptor-stable",
"uniquenessScope": "dataset"
}
]Fields (26)
| Variant | Field | Required | Published constraints |
|---|---|---|---|
| Common | affect | No | {
"type": "string"
} |
| Common | affectedByTitle | No | {
"anyOf": [
{
"$ref": "#/$defs/Objects_"
},
{
"type": "null"
}
]
} |
| Common | amendedByTitle | No | {
"anyOf": [
{
"$ref": "#/$defs/Objects_"
},
{
"type": "null"
}
]
} |
| Common | caveatId | Yes | {
"type": "string"
} |
| Common | caveatKind | Yes | {
"enum": [
"active-uncompiled-amendment",
"future-amendment"
],
"type": "string"
} |
| Common | dateChanged | No | {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
} |
| Common | end | No | {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
} |
| Common | hasUnincorporatedAmendments | No | {
"type": "boolean"
} |
| Common | isCurrent | No | {
"type": "boolean"
} |
| Common | isLatest | Yes | {
"type": "boolean"
} |
| Common | latestCompilationIsCurrent | No | {
"type": "boolean"
} |
| Common | latestCompilationIsLatest | No | {
"type": "boolean"
} |
| Common | latestCompilationNumber | No | {
"type": "string"
} |
| Common | latestCompilationRegisterId | No | {
"type": "string"
} |
| Common | latestCompilationVersionDate | Yes | {
"allOf": [
{
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
}
],
"type": "string"
} |
| Common | markdown | No | {
"type": "string"
} |
| Common | name | Yes | {
"type": "string"
} |
| Common | reasonObserved | Yes | {
"type": "boolean"
} |
| Common | schemaVersion | Yes | {
"type": "string"
} |
| Common | slug | Yes | {
"allOf": [
{
"pattern": "^[a-z0-9]+(-[a-z0-9]+)*$"
}
],
"type": "string"
} |
| Common | sourceStateCheckedAt | Yes | {
"type": "string"
} |
| Common | sourceTextUrl | Yes | {
"allOf": [
{
"pattern": "^https:\\/\\/www\\.legislation\\.gov\\.au\\/.+$"
}
],
"type": "string"
} |
| Common | start | Yes | {
"type": "string"
} |
| Common | status | No | {
"type": "string"
} |
| Common | titleId | Yes | {
"type": "string"
} |
| Common | versionDate | Yes | {
"allOf": [
{
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
}
],
"type": "string"
} |
Complete JSON Schema
{
"$defs": {
"Objects_": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"number": {
"type": "integer"
},
"optionalSeriesNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"provisions": {
"type": "string"
},
"seriesType": {
"type": "string"
},
"titleId": {
"type": "string"
},
"year": {
"type": "integer"
}
},
"required": [
"titleId",
"name"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"affect": {
"type": "string"
},
"affectedByTitle": {
"anyOf": [
{
"$ref": "#/$defs/Objects_"
},
{
"type": "null"
}
]
},
"amendedByTitle": {
"anyOf": [
{
"$ref": "#/$defs/Objects_"
},
{
"type": "null"
}
]
},
"caveatId": {
"type": "string"
},
"caveatKind": {
"enum": [
"active-uncompiled-amendment",
"future-amendment"
],
"type": "string"
},
"dateChanged": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"end": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hasUnincorporatedAmendments": {
"type": "boolean"
},
"isCurrent": {
"type": "boolean"
},
"isLatest": {
"type": "boolean"
},
"latestCompilationIsCurrent": {
"type": "boolean"
},
"latestCompilationIsLatest": {
"type": "boolean"
},
"latestCompilationNumber": {
"type": "string"
},
"latestCompilationRegisterId": {
"type": "string"
},
"latestCompilationVersionDate": {
"allOf": [
{
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
}
],
"type": "string"
},
"markdown": {
"type": "string"
},
"name": {
"type": "string"
},
"reasonObserved": {
"type": "boolean"
},
"schemaVersion": {
"type": "string"
},
"slug": {
"allOf": [
{
"pattern": "^[a-z0-9]+(-[a-z0-9]+)*$"
}
],
"type": "string"
},
"sourceStateCheckedAt": {
"type": "string"
},
"sourceTextUrl": {
"allOf": [
{
"pattern": "^https:\\/\\/www\\.legislation\\.gov\\.au\\/.+$"
}
],
"type": "string"
},
"start": {
"type": "string"
},
"status": {
"type": "string"
},
"titleId": {
"type": "string"
},
"versionDate": {
"allOf": [
{
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
}
],
"type": "string"
}
},
"required": [
"schemaVersion",
"caveatId",
"caveatKind",
"slug",
"titleId",
"name",
"versionDate",
"sourceTextUrl",
"sourceStateCheckedAt",
"latestCompilationVersionDate",
"start",
"isLatest",
"reasonObserved"
],
"type": "object",
"x-legislation": {
"artifactFamilyKey": "frl-caveats",
"artifactPathPattern": ".tooling/frl-caveats/<slug>.jsonl",
"derivationMode": "effect-derived",
"schemaPath": ".tooling/schemas/frl-caveats.schema.json",
"schemaVersion": "1.0.0",
"shapeKind": "encoded-jsonl-record",
"sourceEffectExport": "FrlCaveatRecordJson",
"sourceEffectModule": "src/domain/frlCaveat.ts"
}
}a6de85cccf489b7b121dcec0cddf38c459fff4af3f64d1bc4fde69b4753ec0c5