ProjectSnapshot
Minimal Project Snapshot
Schema-valid JSON for the Project Snapshot resource.
ProjectSnapshot · ORBIT v0.1
Project Snapshot
ProjectSnapshot
Point-in-time observed project and repository state.
OVERVIEW
A factual observation of project and repository state at a specific time.
STRUCTURE
The raw JSON Schema is the machine contract for this resource. The field reference below is derived from that schema.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://orbitspec.dev/schema/project-snapshot/v0.1.json",
"title": "ORBIT Project Snapshot",
"type": "object",
"required": [
"specVersion",
"id",
"project",
"observedAt",
"repositories"
],
"properties": {
"specVersion": {
"const": "0.1",
"description": "ORBIT specification version."
},
"id": {
"type": "string",
"description": "Stable ProjectSnapshot identifier."
},
"project": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Stable project identifier."
}
},
"additionalProperties": false,
"description": "Project identity whose state was observed."
},
"observedAt": {
"type": "string",
"format": "date-time",
"description": "Time at which project state was observed."
},
"repositories": {
"type": "array",
"items": {
"type": "object",
"required": [
"repositoryId",
"branch",
"commit"
],
"properties": {
"repositoryId": {
"type": "string",
"description": "Stable repository identifier."
},
"branch": {
"type": "string",
"description": "Observed branch."
},
"commit": {
"type": "string",
"minLength": 7,
"description": "Observed repository revision."
}
},
"additionalProperties": false
},
"description": "Observed repository states."
}
},
"additionalProperties": false
}FIELD REFERENCE
| Field | Type | Required | Meaning | Constraints |
|---|---|---|---|---|
specVersion | const "0.1" | yes | ORBIT specification version. | must equal "0.1" |
id | string | yes | Stable ProjectSnapshot identifier. | — |
project | object | yes | Project identity whose state was observed. | — |
project.id | string | yes | Stable project identifier. | — |
observedAt | string | yes | Time at which project state was observed. | — |
repositories | array<object> | yes | Observed repository states. | — |
repositories[].repositoryId | string | yes | Stable repository identifier. | — |
repositories[].branch | string | yes | Observed branch. | — |
repositories[].commit | string | yes | Observed repository revision. | minLength 7 |
RELATIONSHIPS
| Resource | Reference | Meaning |
|---|---|---|
| Project | project.id | Identifies the project whose state was observed. |
| Repositories | repositories[].repositoryId | Names each repository and records its branch and commit. |
INVARIANTS
JSON Schema validates structure. These semantic rules explain what a structurally valid ProjectSnapshot must mean in the ORBIT model.
- observedAt records when the project state was observed.
- Repository commits identify the state available to a reconciliation.
- A snapshot may support more than one reconciliation only when it contains the facts relevant to each Plan.
EXAMPLES
ProjectSnapshot
Complete Project Snapshot
Schema-valid JSON for the Project Snapshot resource.
RAW SCHEMA
The canonical machine-readable contract is available at /schema/project-snapshot.schema.json.
Use it for tooling, CI validation, and agent integrations. The human guide explains semantics; the schema defines structural conformance.