Legislation · public publication pilot

consumer-nodes: 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.

Browse the data Consumer guide Download exact schema

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": "canonicalPath",
    "mechanicalInputs": "slug, version date, artifact path, and structural path",
    "stabilityRule": "stable-while-structural-inputs-stable",
    "uniquenessScope": "slug-version"
  },
  {
    "identifierName": "markdownDigest",
    "mechanicalInputs": "sha256 digest of the governed file or text bytes",
    "stabilityRule": "content-addressed",
    "uniquenessScope": "artifact-family"
  },
  {
    "identifierName": "slug",
    "mechanicalInputs": "source descriptor slug",
    "stabilityRule": "stable-while-source-descriptor-stable",
    "uniquenessScope": "dataset"
  },
  {
    "identifierName": "slugFingerprintDigest",
    "mechanicalInputs": "sha256 digest of the governed file or text bytes",
    "stabilityRule": "content-addressed",
    "uniquenessScope": "artifact-family"
  }
]

Fields (23)

Variant	Field	Required	Published constraints
Common	`artifactKind`	Yes	{ "enum": [ "file", "directory-index", "document-frontmatter", "document-contents", "document-preamble" ], "type": "string" }
Common	`artifactRelativePath`	Yes	{ "allOf": [ { "pattern": "^(?!\\/)(?!.(?:^\|\\/)\\.\\.(?:\\/\|$))(?!.\\/\\/)[^\\0\\r\\n]+\\.md$" } ], "type": "string" }
Common	`canonicalPath`	Yes	{ "allOf": [ { "pattern": "^(?!\\/)(?!.(?:^\|\\/)\\.\\.(?:\\/\|$))(?!.\\/\\/)[^\\0\\r\\n]+$" } ], "type": "string" }
Common	`contentBlockEndExclusive`	Yes	{ "type": "integer" }
Common	`contentBlockStartIndex`	Yes	{ "type": "integer" }
Common	`documentOrder`	Yes	{ "type": "integer" }
Common	`headingBlockIndex`	Yes	{ "type": "integer" }
Common	`headingText`	Yes	{ "type": "string" }
Common	`headingTrail`	Yes	{ "items": { "type": "string" }, "type": "array" }
Common	`markdown`	Yes	{ "type": "string" }
Common	`markdownDigest`	Yes	{ "allOf": [ { "pattern": "^[0-9a-f]{64}$" } ], "type": "string" }
Common	`markdownDigestAlgorithm`	Yes	{ "enum": [ "sha256" ], "type": "string" }
Common	`name`	Yes	{ "type": "string" }
Common	`schemaVersion`	Yes	{ "type": "string" }
Common	`slug`	Yes	{ "allOf": [ { "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" } ], "type": "string" }
Common	`slugFingerprintDigest`	Yes	{ "allOf": [ { "pattern": "^[0-9a-f]{64}$" } ], "type": "string" }
Common	`sourceDocumentPath`	Yes	{ "type": "string" }
Common	`sourceIndexKind`	Yes	{ "enum": [ "body-block", "body-div" ], "type": "string" }
Common	`sourceTextUrl`	Yes	{ "allOf": [ { "pattern": "^https:\\/\\/www\\.legislation\\.gov\\.au\\/.+$" } ], "type": "string" }
Common	`structuralPath`	Yes	{ "items": { "type": "string" }, "type": "array" }
Common	`substantiveBlockCount`	Yes	{ "type": "integer" }
Common	`titleId`	Yes	{ "type": "string" }
Common	`versionDate`	Yes	{ "allOf": [ { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" } ], "type": "string" }

Complete JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "artifactKind": {
      "enum": [
        "file",
        "directory-index",
        "document-frontmatter",
        "document-contents",
        "document-preamble"
      ],
      "type": "string"
    },
    "artifactRelativePath": {
      "allOf": [
        {
          "pattern": "^(?!\\/)(?!.*(?:^|\\/)\\.\\.(?:\\/|$))(?!.*\\/\\/)[^\\0\\r\\n]+\\.md$"
        }
      ],
      "type": "string"
    },
    "canonicalPath": {
      "allOf": [
        {
          "pattern": "^(?!\\/)(?!.*(?:^|\\/)\\.\\.(?:\\/|$))(?!.*\\/\\/)[^\\0\\r\\n]+$"
        }
      ],
      "type": "string"
    },
    "contentBlockEndExclusive": {
      "type": "integer"
    },
    "contentBlockStartIndex": {
      "type": "integer"
    },
    "documentOrder": {
      "type": "integer"
    },
    "headingBlockIndex": {
      "type": "integer"
    },
    "headingText": {
      "type": "string"
    },
    "headingTrail": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "markdown": {
      "type": "string"
    },
    "markdownDigest": {
      "allOf": [
        {
          "pattern": "^[0-9a-f]{64}$"
        }
      ],
      "type": "string"
    },
    "markdownDigestAlgorithm": {
      "enum": [
        "sha256"
      ],
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "schemaVersion": {
      "type": "string"
    },
    "slug": {
      "allOf": [
        {
          "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$"
        }
      ],
      "type": "string"
    },
    "slugFingerprintDigest": {
      "allOf": [
        {
          "pattern": "^[0-9a-f]{64}$"
        }
      ],
      "type": "string"
    },
    "sourceDocumentPath": {
      "type": "string"
    },
    "sourceIndexKind": {
      "enum": [
        "body-block",
        "body-div"
      ],
      "type": "string"
    },
    "sourceTextUrl": {
      "allOf": [
        {
          "pattern": "^https:\\/\\/www\\.legislation\\.gov\\.au\\/.+$"
        }
      ],
      "type": "string"
    },
    "structuralPath": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "substantiveBlockCount": {
      "type": "integer"
    },
    "titleId": {
      "type": "string"
    },
    "versionDate": {
      "allOf": [
        {
          "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
        }
      ],
      "type": "string"
    }
  },
  "required": [
    "schemaVersion",
    "slug",
    "titleId",
    "name",
    "versionDate",
    "sourceTextUrl",
    "canonicalPath",
    "artifactRelativePath",
    "artifactKind",
    "structuralPath",
    "headingTrail",
    "headingText",
    "documentOrder",
    "sourceDocumentPath",
    "sourceIndexKind",
    "headingBlockIndex",
    "contentBlockStartIndex",
    "contentBlockEndExclusive",
    "substantiveBlockCount",
    "markdown",
    "markdownDigestAlgorithm",
    "markdownDigest",
    "slugFingerprintDigest"
  ],
  "type": "object",
  "x-legislation": {
    "artifactFamilyKey": "consumer-nodes",
    "artifactPathPattern": ".tooling/consumer-nodes/<slug>.jsonl",
    "derivationMode": "effect-derived",
    "schemaPath": ".tooling/schemas/consumer-nodes.schema.json",
    "schemaVersion": "1.0.0",
    "shapeKind": "encoded-jsonl-record",
    "sourceEffectExport": "ConsumerNodeRecordJson",
    "sourceEffectModule": "src/domain/consumerSurface.ts"
  }
}

a6de85cccf489b7b121dcec0cddf38c459fff4af3f64d1bc4fde69b4753ec0c5