Skip to content

Spatial Pack Manifest

Schema for spatialpack.json manifest files - the core metadata document for Spatial Packs

This schema defines 18 fields (8 required, 10 optional).

FieldTypeRequiredDescriptionConstraints
pack_idstringYesGlobally unique pack identifierPattern: ^[a-z0-9.-]+:[a-z]{2,3}:[a-z0-9-]+:v[0-9]+$. Examples: spatial.properties:wa:land-greenfield:v1
versionstringYesPack version (semver or YYYY.MM.DD format)Pattern: ^([0-9]+\.[0-9]+\.[0-9]+|[0-9]{4}\.[0-9]{2}\.[0-9]{2})$. Examples: 1.0.0, 2025.01.03
created_atstringYesISO 8601 timestamp when pack was createdFormat: date-time
updated_atstringNoISO 8601 timestamp when pack was last updatedFormat: date-time
geographystringYesGeographic region code (ISO 3166-2 subdivision or custom)Min length: 2. Max length: 10. Examples: wa, au-wa, global
themestringYesThematic category for the packPattern: ^[a-z0-9-]+$. Examples: land-greenfield, solar-feasibility, bushfire-ops
bboxarray of numberYesBounding box [minX, minY, maxX, maxY] in CRS unitsMin items: 4. Max items: 4
crsstringYesCoordinate Reference System (EPSG code)Pattern: ^EPSG:[0-9]+$. Default: EPSG:4326. Examples: EPSG:4326, EPSG:3857
analysis_crsstring \nullNoProjected CRS used for metric computation (e.g., EPSG:7850)
tenantstringNoTenant identifier for multi-tenant deployments-
licenseLicenseNoLicense information for the pack-
provenanceProvenanceNoData provenance and lineage-
layersarray of LayerYesArray of layer definitionsMin items: 1. See Layer Schema for field-by-field detail.
deltasarray of DeltaNoDelta updates from previous versions-
integrityIntegrityNoIntegrity verification hashes-
retentionobjectNoRetention policy for the pack-
securitySecurityNoSecurity classification and access notes-
extensionsobjectNoOptional extensions (STAC, CSP-1, custom)-

License information for the pack

Required fields: id, name

FieldTypeRequiredDescriptionConstraints
idstringYesLicense identifier (SPDX or custom)-
namestringYesHuman-readable license name-
attributionstringNoRequired attribution text-
urlstringNoURL to full license termsFormat: uri

Data provenance and lineage

FieldTypeRequiredDescriptionConstraints
sourcesarray of SourceNoSource datasets used to create this pack-
derived_fromarray of stringNoOther packs this pack is derived from-

The sources field contains items defined in Source.

Source dataset reference

Required fields: name, id

FieldTypeRequiredDescriptionConstraints
namestringYesHuman-readable source name-
idstringYesSource identifier-
versionstringNoSource version or date-
licensestringNoLicense type (SPDX or custom)-
urlstringNoURL to source metadataFormat: uri
sha256stringNoSHA256 hash of source dataPattern: ^[a-f0-9]{64}$

Delta update reference

Required fields: from_version, to_version

FieldTypeRequiredDescriptionConstraints
from_versionstringYes-
to_versionstringYes-
delta_uristringNoFormat: uri
operationsarray of stringNoItem values: add, update, delete

Integrity verification hashes

FieldTypeRequiredDescriptionConstraints
manifest_sha256stringNoSHA256 hash of manifest (excluding this field)-
asset_hashesobject: {string: string}NoMap of asset filename to hash-

Security classification and access notes

FieldTypeRequiredDescriptionConstraints
classificationstringNoOverall security classificationValues: public, internal, restricted, mixed
notesstringNoAdditional security notes-