Eraser · Schema

Eraser Diagram

Schema for an Eraser diagram element within a file

DiagramsDocumentationAITechnical DocumentationDiagrammingArchitectureDeveloper Tools

Properties

Name Type Description
id string Unique diagram identifier
diagramUrl string Canvas URL for viewing the diagram in Eraser
diagramType string The type of this diagram
code string Eraser DSL code defining the diagram content
updatedAt string ISO 8601 timestamp of last modification
View JSON Schema on GitHub

JSON Schema

eraser-diagram-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/eraser/main/json-schema/eraser-diagram-schema.json",
  "title": "Eraser Diagram",
  "description": "Schema for an Eraser diagram element within a file",
  "type": "object",
  "required": ["id", "diagramUrl", "diagramType", "code", "updatedAt"],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique diagram identifier"
    },
    "diagramUrl": {
      "type": "string",
      "format": "uri",
      "description": "Canvas URL for viewing the diagram in Eraser"
    },
    "diagramType": {
      "type": "string",
      "enum": [
        "sequence-diagram",
        "entity-relationship-diagram",
        "cloud-architecture-diagram",
        "flowchart-diagram",
        "bpmn-diagram"
      ],
      "description": "The type of this diagram"
    },
    "code": {
      "type": "string",
      "description": "Eraser DSL code defining the diagram content"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp of last modification"
    }
  }
}