@vev-software/atlas-contracts 0.1.2 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts
CHANGED
|
@@ -193,17 +193,27 @@ export interface Observation {
|
|
|
193
193
|
application?: ApplicationDetails;
|
|
194
194
|
server?: ServerDetails;
|
|
195
195
|
infrastructure?: InfrastructureDetails;
|
|
196
|
+
dataArea?: DataAreaDetails;
|
|
197
|
+
dataset?: DatasetDetails;
|
|
198
|
+
column?: ColumnDetails;
|
|
196
199
|
}
|
|
197
200
|
/**
|
|
198
201
|
* The public wire format a discovery scanner emits into Atlas: a batch of raw observations that
|
|
199
202
|
* the private Atlas Enterprise reconciliation engine turns into catalogue assets.
|
|
200
203
|
*/
|
|
204
|
+
export interface ObservedRelationship {
|
|
205
|
+
fromObservedId: string;
|
|
206
|
+
toObservedId: string;
|
|
207
|
+
type: RelationshipType;
|
|
208
|
+
description?: string | null;
|
|
209
|
+
}
|
|
201
210
|
export interface DiscoveryObservationBatch {
|
|
202
211
|
contractVersion: typeof CONTRACT_VERSION;
|
|
203
212
|
kind: "discovery-observation";
|
|
204
213
|
source: ObservationSource;
|
|
205
214
|
observedAt: string;
|
|
206
215
|
observations: Observation[];
|
|
216
|
+
relationships?: ObservedRelationship[];
|
|
207
217
|
}
|
|
208
218
|
/** The layout format of a `Diagram`. */
|
|
209
219
|
export type DiagramFormat = "atlas-layout";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vev-software/atlas-contracts",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.4",
|
|
4
4
|
"description": "Public, versioned data model and interop contracts for VEV Atlas — the catalogue asset model plus manual relationships, tags and the landscape import/export document.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"type": "module",
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://contracts.vev.software/atlas/v1/discovery-observation.schema.json",
|
|
4
4
|
"title": "Atlas discovery observation batch (v1)",
|
|
5
|
-
"description": "The public wire format a discovery scanner emits INTO Atlas: a batch of raw observations of an IT landscape (servers, applications, infrastructure) that the private Atlas Enterprise reconciliation engine correlates, deduplicates and turns into catalogue assets. This contract carries facts only — an observation has no Atlas 'id' and no 'lifecycle' (the reconciler assigns those), and never any analysis (no EOL/risk, no criticality, no portfolio scoring). Open so third parties can build scanners; the reconciliation logic that consumes it is the private moat and is NOT part of this repo. See handbook 11 §3, 12 §Phase A, and vev-software/atlas-enterprise#6/#9.",
|
|
5
|
+
"description": "The public wire format a discovery scanner emits INTO Atlas: a batch of raw observations of an IT landscape (servers, applications, infrastructure, and the data layer down to data-areas, datasets and columns) that the private Atlas Enterprise reconciliation engine correlates, deduplicates and turns into catalogue assets. This contract carries facts only — an observation has no Atlas 'id' and no 'lifecycle' (the reconciler assigns those), and never any analysis (no EOL/risk, no criticality, no portfolio scoring). Open so third parties can build scanners; the reconciliation logic that consumes it is the private moat and is NOT part of this repo. See handbook 11 §3, 12 §Phase A, and vev-software/atlas-enterprise#6/#9.",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"additionalProperties": false,
|
|
8
8
|
"required": ["contractVersion", "kind", "source", "observedAt", "observations"],
|
|
@@ -31,9 +31,41 @@
|
|
|
31
31
|
"description": "The raw observations in this batch. May be empty (a scan that saw nothing new).",
|
|
32
32
|
"items": { "$ref": "#/$defs/Observation" },
|
|
33
33
|
"default": []
|
|
34
|
+
},
|
|
35
|
+
"relationships": {
|
|
36
|
+
"type": "array",
|
|
37
|
+
"description": "Observed relationships between the things in this batch, referenced by their observedId — e.g. a foreign key (joins-on) or data-layer containment (part-of). Optional and defaults to empty, so a scanner that emits none stays valid. Held facts only; the private reconciler resolves the observedId endpoints to catalogue assets.",
|
|
38
|
+
"items": { "$ref": "#/$defs/ObservedRelationship" },
|
|
39
|
+
"default": []
|
|
34
40
|
}
|
|
35
41
|
},
|
|
36
42
|
"$defs": {
|
|
43
|
+
"ObservedRelationship": {
|
|
44
|
+
"type": "object",
|
|
45
|
+
"description": "A relationship between two observed things, by observedId. NOT an Atlas relationship (no asset ids); the reconciler resolves endpoints and re-expresses it in the catalogue.",
|
|
46
|
+
"additionalProperties": false,
|
|
47
|
+
"required": ["fromObservedId", "toObservedId", "type"],
|
|
48
|
+
"properties": {
|
|
49
|
+
"fromObservedId": {
|
|
50
|
+
"type": "string",
|
|
51
|
+
"description": "The referencing observation's observedId.",
|
|
52
|
+
"minLength": 1,
|
|
53
|
+
"maxLength": 256
|
|
54
|
+
},
|
|
55
|
+
"toObservedId": {
|
|
56
|
+
"type": "string",
|
|
57
|
+
"description": "The referenced observation's observedId.",
|
|
58
|
+
"minLength": 1,
|
|
59
|
+
"maxLength": 256
|
|
60
|
+
},
|
|
61
|
+
"type": {
|
|
62
|
+
"type": "string",
|
|
63
|
+
"description": "The held relationship vocabulary. Mirrors relationship.schema.json.",
|
|
64
|
+
"enum": ["runs-on", "hosts", "connects-to", "depends-on", "part-of", "joins-on"]
|
|
65
|
+
},
|
|
66
|
+
"description": { "type": ["string", "null"], "maxLength": 1024 }
|
|
67
|
+
}
|
|
68
|
+
},
|
|
37
69
|
"ObservationSource": {
|
|
38
70
|
"type": "object",
|
|
39
71
|
"description": "Which scanner produced the batch. The authoritative tenant binding is the authenticated machine-principal at ingestion (a Fabric concern), NOT this payload; 'tenantRef' is an optional, opaque hint only.",
|
|
@@ -134,6 +166,18 @@
|
|
|
134
166
|
{
|
|
135
167
|
"if": { "properties": { "kind": { "const": "infrastructure" } } },
|
|
136
168
|
"then": { "properties": { "infrastructure": { "$ref": "common.schema.json#/$defs/InfrastructureDetails" } } }
|
|
169
|
+
},
|
|
170
|
+
{
|
|
171
|
+
"if": { "properties": { "kind": { "const": "data-area" } } },
|
|
172
|
+
"then": { "properties": { "dataArea": { "$ref": "common.schema.json#/$defs/DataAreaDetails" } } }
|
|
173
|
+
},
|
|
174
|
+
{
|
|
175
|
+
"if": { "properties": { "kind": { "const": "dataset" } } },
|
|
176
|
+
"then": { "properties": { "dataset": { "$ref": "common.schema.json#/$defs/DatasetDetails" } } }
|
|
177
|
+
},
|
|
178
|
+
{
|
|
179
|
+
"if": { "properties": { "kind": { "const": "column" } } },
|
|
180
|
+
"then": { "properties": { "column": { "$ref": "common.schema.json#/$defs/ColumnDetails" } } }
|
|
137
181
|
}
|
|
138
182
|
]
|
|
139
183
|
},
|