Spatial Pack Manifest
Spatial Pack Manifest
Section titled “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).
Fields
Section titled “Fields”| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
pack_id | string | Yes | Globally unique pack identifier | Pattern: ^[a-z0-9.-]+:[a-z]{2,3}:[a-z0-9-]+:v[0-9]+$. Examples: spatial.properties:wa:land-greenfield:v1 |
version | string | Yes | Pack 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_at | string | Yes | ISO 8601 timestamp when pack was created | Format: date-time |
updated_at | string | No | ISO 8601 timestamp when pack was last updated | Format: date-time |
geography | string | Yes | Geographic region code (ISO 3166-2 subdivision or custom) | Min length: 2. Max length: 10. Examples: wa, au-wa, global |
theme | string | Yes | Thematic category for the pack | Pattern: ^[a-z0-9-]+$. Examples: land-greenfield, solar-feasibility, bushfire-ops |
bbox | array of number | Yes | Bounding box [minX, minY, maxX, maxY] in CRS units | Min items: 4. Max items: 4 |
crs | string | Yes | Coordinate Reference System (EPSG code) | Pattern: ^EPSG:[0-9]+$. Default: EPSG:4326. Examples: EPSG:4326, EPSG:3857 |
analysis_crs | string \ | null | No | Projected CRS used for metric computation (e.g., EPSG:7850) |
tenant | string | No | Tenant identifier for multi-tenant deployments | - |
license | License | No | License information for the pack | - |
provenance | Provenance | No | Data provenance and lineage | - |
layers | array of Layer | Yes | Array of layer definitions | Min items: 1. See Layer Schema for field-by-field detail. |
deltas | array of Delta | No | Delta updates from previous versions | - |
integrity | Integrity | No | Integrity verification hashes | - |
retention | object | No | Retention policy for the pack | - |
security | Security | No | Security classification and access notes | - |
extensions | object | No | Optional extensions (STAC, CSP-1, custom) | - |
Definitions
Section titled “Definitions”License
Section titled “License”License information for the pack
Required fields: id, name
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
id | string | Yes | License identifier (SPDX or custom) | - |
name | string | Yes | Human-readable license name | - |
attribution | string | No | Required attribution text | - |
url | string | No | URL to full license terms | Format: uri |
Provenance
Section titled “Provenance”Data provenance and lineage
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
sources | array of Source | No | Source datasets used to create this pack | - |
derived_from | array of string | No | Other packs this pack is derived from | - |
The sources field contains items defined in Source.
Source
Section titled “Source”Source dataset reference
Required fields: name, id
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
name | string | Yes | Human-readable source name | - |
id | string | Yes | Source identifier | - |
version | string | No | Source version or date | - |
license | string | No | License type (SPDX or custom) | - |
url | string | No | URL to source metadata | Format: uri |
sha256 | string | No | SHA256 hash of source data | Pattern: ^[a-f0-9]{64}$ |
Delta update reference
Required fields: from_version, to_version
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
from_version | string | Yes | - | |
to_version | string | Yes | - | |
delta_uri | string | No | Format: uri | |
operations | array of string | No | Item values: add, update, delete |
Integrity
Section titled “Integrity”Integrity verification hashes
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
manifest_sha256 | string | No | SHA256 hash of manifest (excluding this field) | - |
asset_hashes | object: {string: string} | No | Map of asset filename to hash | - |
Security
Section titled “Security”Security classification and access notes
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
classification | string | No | Overall security classification | Values: public, internal, restricted, mixed |
notes | string | No | Additional security notes | - |