root-at-skic
ebf320a023
- *.archify-decision files: id (unique, words), title, status, date, elements, diagrams, supersedes, and prose; parsed, merged and link-checked in the model index; diagnostics on the file - diagrams point at decisions with decisions: [...] on the diagram, nodes and edges; stripped before Archify, unknown ids reported, completion, hover and go-to-definition for the ids and for elements/diagrams/ supersedes in decision files - Decisions panel on the main.archify page; Decisions rail panel under a diagram (hover lights up the node or connection); decisions on element cards and in the element dialog; decision view for the file, with a lost-model note outside a model - Archify | New Decision… command and template; editor schemas; the three New Model examples carry decisions; docs, changelog, 0.8.0
317 lines
7.9 KiB
JSON
317 lines
7.9 KiB
JSON
{
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"title": "Archify Data Flow Diagram",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"schema_version",
|
|
"diagram_type",
|
|
"meta",
|
|
"stages",
|
|
"nodes",
|
|
"flows"
|
|
],
|
|
"properties": {
|
|
"schema_version": {
|
|
"const": 1
|
|
},
|
|
"diagram_type": {
|
|
"const": "dataflow"
|
|
},
|
|
"meta": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"title",
|
|
"output"
|
|
],
|
|
"properties": {
|
|
"title": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"locale": {
|
|
"$ref": "common.schema.json#/$defs/locale"
|
|
},
|
|
"translations": {
|
|
"$ref": "common.schema.json#/$defs/translations"
|
|
},
|
|
"subtitle": {
|
|
"type": "string"
|
|
},
|
|
"output": {
|
|
"$ref": "common.schema.json#/$defs/portableOutputPath"
|
|
},
|
|
"animation": {
|
|
"$ref": "common.schema.json#/$defs/animation"
|
|
},
|
|
"visual_preset": {
|
|
"$ref": "common.schema.json#/$defs/visualPreset"
|
|
},
|
|
"quality_profile": {
|
|
"$ref": "common.schema.json#/$defs/qualityProfile"
|
|
},
|
|
"repository": {
|
|
"$ref": "common.schema.json#/$defs/repository"
|
|
},
|
|
"views": {
|
|
"$ref": "common.schema.json#/$defs/guidedViews"
|
|
},
|
|
"legend": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"mode": {
|
|
"$ref": "common.schema.json#/$defs/legendMode"
|
|
},
|
|
"entries": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"default": {
|
|
"$ref": "common.schema.json#/$defs/legendEntry"
|
|
},
|
|
"emphasis": {
|
|
"$ref": "common.schema.json#/$defs/legendEntry"
|
|
},
|
|
"security": {
|
|
"$ref": "common.schema.json#/$defs/legendEntry"
|
|
},
|
|
"dashed": {
|
|
"$ref": "common.schema.json#/$defs/legendEntry"
|
|
},
|
|
"database": {
|
|
"$ref": "common.schema.json#/$defs/legendEntry"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"viewBox": {
|
|
"type": "array",
|
|
"prefixItems": [
|
|
{
|
|
"type": "number",
|
|
"minimum": 360
|
|
},
|
|
{
|
|
"type": "number",
|
|
"minimum": 360
|
|
}
|
|
],
|
|
"items": false,
|
|
"minItems": 2,
|
|
"maxItems": 2
|
|
}
|
|
}
|
|
},
|
|
"stages": {
|
|
"type": "array",
|
|
"minItems": 2,
|
|
"maxItems": 5,
|
|
"items": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"label"
|
|
],
|
|
"properties": {
|
|
"label": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"nodes": {
|
|
"type": "array",
|
|
"minItems": 2,
|
|
"items": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"label",
|
|
"stage",
|
|
"row"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"$ref": "common.schema.json#/$defs/id"
|
|
},
|
|
"type": {
|
|
"$ref": "common.schema.json#/$defs/componentType"
|
|
},
|
|
"label": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"sublabel": {
|
|
"type": "string"
|
|
},
|
|
"tag": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"$ref": "common.schema.json#/$defs/nodeIcon"
|
|
},
|
|
"brand": {
|
|
"$ref": "common.schema.json#/$defs/brandMark"
|
|
},
|
|
"sources": {
|
|
"$ref": "common.schema.json#/$defs/sourceReferences"
|
|
},
|
|
"stage": {
|
|
"type": "integer",
|
|
"minimum": 0
|
|
},
|
|
"row": {
|
|
"type": "integer",
|
|
"minimum": 0
|
|
},
|
|
"width": {
|
|
"type": "number",
|
|
"minimum": 48
|
|
},
|
|
"height": {
|
|
"type": "number",
|
|
"minimum": 36
|
|
},
|
|
"yOffset": {
|
|
"type": "number"
|
|
},
|
|
"decisions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"flows": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"from",
|
|
"to",
|
|
"label"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"$ref": "common.schema.json#/$defs/id"
|
|
},
|
|
"from": {
|
|
"$ref": "common.schema.json#/$defs/id"
|
|
},
|
|
"to": {
|
|
"$ref": "common.schema.json#/$defs/id"
|
|
},
|
|
"label": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"classification": {
|
|
"type": "string"
|
|
},
|
|
"variant": {
|
|
"$ref": "common.schema.json#/$defs/variant"
|
|
},
|
|
"route": {
|
|
"enum": [
|
|
"auto",
|
|
"straight",
|
|
"vertical-channel",
|
|
"bottom-channel",
|
|
"top-channel"
|
|
]
|
|
},
|
|
"fromSide": {
|
|
"$ref": "common.schema.json#/$defs/side"
|
|
},
|
|
"toSide": {
|
|
"$ref": "common.schema.json#/$defs/side"
|
|
},
|
|
"channelX": {
|
|
"type": "number"
|
|
},
|
|
"channelY": {
|
|
"type": "number"
|
|
},
|
|
"labelAt": {
|
|
"$ref": "common.schema.json#/$defs/point"
|
|
},
|
|
"labelDx": {
|
|
"type": "number"
|
|
},
|
|
"labelDy": {
|
|
"type": "number"
|
|
},
|
|
"labelSegment": {
|
|
"type": "integer",
|
|
"minimum": 0
|
|
},
|
|
"via": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "common.schema.json#/$defs/point"
|
|
}
|
|
},
|
|
"width": {
|
|
"$ref": "common.schema.json#/$defs/relationshipWidth"
|
|
},
|
|
"decisions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"cards": {
|
|
"$ref": "common.schema.json#/$defs/cards"
|
|
},
|
|
"model": {
|
|
"type": "object",
|
|
"description": "Only in main.archify: the entry point of a model (a folder of diagrams that belong together).",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$",
|
|
"description": "Stable id of the model."
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Name shown on the model page."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "What the model covers; shown on the model page."
|
|
}
|
|
}
|
|
},
|
|
"decisions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
|
|
}
|
|
}
|
|
}
|