New Bring your own storage. Keep your diagrams in your own private GitHub repository, on Pro and Team.Bring your own storage on GitHub, for Pro and Team. Learn more about bring your own storage

Validation rules

Checking a diagram, saving it and editing it report each problem with a code, the element it concerns when there is one, and a one-line fix. This page lists every code those calls return and what to change for each, except LIMIT_NEAR, which says the workspace is near a plan limit (Limits: Before a limit). It also lists LAYER_HAS_LAYOUT, an info-level note the API doesn’t return.

For the rules and refusals below, fix is the first sentence of the message in the table, cut at 160 characters, where {name} stands for the value that fills it in. A code whose message depends on the case shows each message on its own line. Drawing warnings and Mermaid notes give the whole line shown.

Scene and operation rules

A create and a check run these rules on the scene sent. An edit checks its operations against the diagram’s current revision, then checks the revision it makes: an error that revision has and the current one doesn’t refuses the edit, and its warnings come back with the saved edit. An error the diagram already had doesn’t block an edit that leaves it as it was. A restoreRevision isn’t checked: it brings back an earlier version exactly. The diagram family rules apply only when the scene declares diagramFamily.

Document shape

CodeSeverityMessageWhat to change
SCHEMA_VALIDATION_ERRORerror{path}: {what the schema expects}Change the field at the path the fix names to what the schema allows: scene.schema.json for a scene, ops.schema.json for operations. For an unknown property the fix says what to use instead, or lists the properties allowed there; for a value outside a list, the values allowed, nearest first. A list too long for the line ends with how many it leaves out.
OP_REMOVEDerror{op} was removed: {what to send instead}Drop the operation and do what the fix says. normalizeScene is gone because every save normalizes and lays out the diagram.

Size limits

CodeSeverityMessageWhat to change
CONTENT_LIMIT_EXCEEDEDerrorScene has {count} elements, exceeding limit of {maxElements}.
Canvas {width or height} {value} exceeds limit of {maxSceneWidth}.
{Kind} ‘{id}’ has {label, text or step} text length {length}, exceeding limit of {maxTextLength}.
Containment nesting depth is {depth}, exceeding limit of {maxNestingDepth}.
{Kind} ‘{id}’ has layout {x, y, width or height} {value}, exceeding limit of {maxCoordinate}.
The document nests {depth} levels deep, exceeding limit of {maxJsonDepth}.
Make the diagram smaller, or split it into several; for a position or size past the limit, bring the element within 100,000 px of zero. The limits: 1,000 elements, edges included; containers nested 10 deep; 10,000 characters in one label or text element; a canvas of 20,000 by 20,000; a position or size within 100,000 px of zero; JSON nested 32 levels deep.

IDs and styles

CodeSeverityMessageWhat to change
ELEMENT_ID_DUPLICATEerrorDuplicate element ID: ‘{id}’.Give each element its own id. The error has no element; the fix names the ID.
STYLE_NOT_FOUNDerrorStyle token ‘{style}’ not found in style registry.Add the token to the scene’s styles, or give the element an inline style object.
ACCENT_COLOR_NOT_DRAWNwarningaccentColor draws nothing on {nodes, entities, lines, texts, images, guides, groups or zones} {up to three IDs}: {what colors it instead, or remove it}. A frame, an er.entity or er.weakEntity with columns, an org.person or org.role card and a uiflow.screen or uiflow.modal draw it.Remove accentColor, or color the element by what it is: fill and stroke for a node, stroke for a line, textColor for text. A group draws nothing: use a frame, and accentColor colors it. An ER entity draws a header once it has extensions.columns, and a Google Cloud zone’s strips keep Google’s colors.

References

CodeSeverityMessageWhat to change
CHILD_ELEMENT_NOT_FOUNDerrorChild element ‘{child}’ referenced by {kind} ‘{id}’ does not exist.Create the child, or remove its ID from the container’s children.
EDGE_ENDPOINT_MISSINGerrorEdge ‘{id}’ is missing a ‘from’ endpoint with an elementId.Give the edge both from and to, each with an elementId.
EDGE_ENDPOINT_ELEMENT_NOT_FOUNDerrorEdge ‘{id}’ from-endpoint references element ‘{element}’ which does not exist.Point the endpoint at an element that exists, or, in an edit, create the element in the same ops.
EDGE_ANCHOR_IGNOREDwarningEdge ‘{edge}’ {side}.anchor is ignored because {reason}.Remove the endpoint’s anchor. A sequence message runs between lifelines, a self-loop takes its own side, and an end with a column sits at that column’s row, so an anchor there does nothing.
EDGE_COLUMN_NOT_FOUNDwarningEdge ‘{edge}’ {side} column ‘{column}’ isn’t on ‘{element}’: use one of {columns}, or remove column.Set the endpoint’s column to one the fix lists, or remove it. Without it the edge docks on the entity’s side as any edge does: at its center, or straight across where the nodes line up. An entity with no extensions.columns gets “add the column there” instead of the list.
SPAN_TARGET_NOT_FOUNDerrorSpanning frame ‘{id}’ spans ‘{target}’, which doesn’t exist: create it, or remove it from spans.Create the element, or remove its ID from the spanning frame’s spans. In an edit, a target that no operation creates is OP_TARGET_NOT_FOUND instead.

Groups and frames

CodeSeverityMessageWhat to change
SELF_CONTAINMENTerrorContainer ‘{id}’ cannot contain itself.Remove the container’s own ID from its children.
INVALID_CHILD_KIND_FOR_CONTAINERerrorGuide element ‘{child}’ cannot be a child of {kind} ‘{id}’.Remove the guide from children. Guides can’t be grouped or framed.
MULTIPLE_GROUP_MEMBERSHIPerrorElement ‘{child}’ belongs to multiple groups: {groups}.Keep the element in the children of one group only.
MULTIPLE_FRAME_MEMBERSHIPerrorElement ‘{child}’ belongs to multiple frames: {frames}.Keep the element in the children of one frame only. To nest frames, list the inner frame in the outer frame’s children. To draw a frame round elements that have frames of their own, such as an Auto Scaling group across Availability Zones, give it spans instead of children in an architecture diagram or one without a family, the ones that draw it: a spanning frame isn’t counted here.
POOL_NODE_OUTSIDE_LANEwarningNode ‘{id}’ is in no lane of {type} ‘{pool}’: move it into a lane with updateNode’s frame field. Until then it is drawn in an untitled band after the lanes.Put the node in one of the pool’s lanes: updateNode with frame set to the lane’s ID moves it there. A pool with lanes draws the nodes it lists itself in an untitled band after its last lane.
LANE_OUTSIDE_POOLwarningLane ‘{lane}’ is in no pool: list it in a pool’s children (in an edit, delete the pool and create it again with the lane among them). Until then it is drawn as a pool of one lane.List the lane in a pool’s children, or give the frame containerType: "pool" (updateFrame on a saved diagram). createFrame with frame adds a new lane to a saved pool; no edit op moves an existing lane into one: in one edit, deleteElement the pool (its lanes and tasks stay) and createFrame it again with the lane among its children, in the order the lanes should run. A lane outside every pool is drawn as a pool of one lane.
CONTAINMENT_CYCLEerrorContainment cycle detected involving ‘{node}’.Break the loop: no container may contain, directly or through others, a container that contains it.
AWS_FRAME_HIDES_GROUPSwarningMove the AWS groups this generic frame holds into the AWS group around it, or, for a group across Availability Zones, draw it round the subnets with spans. Frame ‘{id}’ hides {presets} from the AWS layout: list {them} in ‘{parent}’ directly.
Move the AWS groups this generic frame holds into the AWS group around it, or put the frame around the whole VPC or Region instead. Frame ‘{id}’ hides {presets} from the AWS layout: list {them} in ‘{parent}’ directly.
Take the AWS groups the message names out of the generic frame and list them in the AWS group it names. The first message comes for a frame that hides subnets: a group across Availability Zones round subnets, or round what they hold, can be a spanning frame instead, written with spans, and the rows keep room for its header (Layout Engine: Spanning frames). The second comes for a frame that hides Availability Zones or VPCs: move it out to wrap the whole VPC or Region, since a spanning frame round them gets no room for its header. The layout reads through a generic frame round all of a VPC’s Availability Zones (an EKS cluster), round whole VPCs in a Region, or round subnets next to each other in one Availability Zone’s rows (a tier), and arranges what it holds as AWS does. Any other generic frame inside a Region, VPC, Availability Zone or subnet keeps its own box, so the groups in it lose that arrangement. A frame round nodes only gets no warning. Raised only in architecture diagrams and diagrams without a family, the ones the layout arranges; in another family the presets only draw.
AWS_GROUP_NESTINGwarningAWS group ‘{id}’ ({type}) is inside ‘{parent}’ ({parentType}), where AWS doesn’t draw it: move it into a frame of type {allowed}.
AWS group ‘{id}’ ({type}) is inside ‘{parent}’ ({parentType}), where AWS doesn’t draw it: take it out of every AWS group.
AWS group ‘{id}’ ({type}) isn’t inside a VPC: put it in a frame of type ‘aws.az’ or ‘aws.vpc’.
Nest the presets as AWS does: aws.cloud (aws.account inside it), aws.region, aws.vpc, aws.az, then the subnets; a security or Auto Scaling group in a subnet, AZ or VPC, or across AZs as a spanning frame (spans), which this check skips; a corporate data center outside every AWS group. The check reads through generic frames: it compares a preset with the nearest preset round it, and AWS_FRAME_HIDES_GROUPS names a generic frame the layout can’t arrange through (Layout Engine: AWS architecture diagrams). Until it moves, it is laid out as any frame, except a subnet a Region lists directly, which is arranged in the Region’s rows.
AWS_GROUP_UNTYPEDwarningSet this frame’s containerType to ‘{preset}’ if it is {an AWS group}, or leave it generic.
Set this frame’s containerType to ‘aws.subnet.public’ or ‘aws.subnet.private’ if it is an AWS subnet, or leave it generic.
Set the frame’s containerType to the preset the message names, or leave it generic if it isn’t that AWS group. The preset draws AWS’s group style and, in an architecture diagram, arranges what the frame holds. On a saved diagram, send updateFrame for each frame you set and an autoLayout in the same edit (every node moves). The warning comes only for a frame that holds aws:* icons, when its title is a group’s own name, alone or with one identifier (a letter, or a word with a digit): VPC, Private subnet 2, us-west-2. VPC endpoint services and Production VPC get none. A title of Subnet, alone or with an identifier, names both subnet presets: pick the one that fits.
GCP_FRAME_HIDES_GROUPSwarningMove the Google Cloud groups this generic frame holds into the Google Cloud group around it, or draw the frame round them with spans. Frame ‘{id}’ hides {presets} from the Google Cloud layout: list {them} in ‘{parent}’ directly.
Move the Google Cloud groups this generic frame holds into the Google Cloud group around it, or put the frame around the whole Region instead. Frame ‘{id}’ hides {presets} from the Google Cloud layout: list {them} in ‘{parent}’ directly.
Move the tiers this generic frame holds into the subnet around it. Frame ‘{id}’ hides {presets} from the Google Cloud layout: list {them} in ‘{parent}’ directly.
Take the Google Cloud groups the message names out of the generic frame and list them in the group it names. For a frame round subnets (the first message), draw it with spans instead. For one round Regions or other groups (the second), move it out to wrap the whole Region. For one round tiers in a subnet (the third), list the tiers in the subnet: a tier’s cards stand in their zones’ columns only when the subnet lists the tier. A project, or a generic frame round whole Regions, keeps the arrangement (Layout Engine: Google Cloud architecture diagrams). Raised only in architecture diagrams and diagrams without a family.
GCP_GROUP_NESTINGwarningGoogle Cloud group ‘{id}’ ({type}) is inside ‘{parent}’ ({parentType}), where Google doesn’t draw it: move it into a frame of type {allowed}.
Google Cloud group ‘{id}’ ({type}) is inside ‘{parent}’ ({parentType}), where Google doesn’t draw it: take it out of every Google Cloud group.
Google Cloud group ‘{id}’ (gcp.subnet) isn’t inside a Region: put it in a frame of type ‘gcp.region’.
Google Cloud group ‘{id}’ ({type}) holds its members as children: draw it round {targets} with spans instead, and list them in {holders}.
Google Cloud group ‘{id}’ ({type}) spans {targets}, which Google doesn’t draw in it: span only {allowed}.
Google Cloud group ‘{id}’ (gcp.zone) spans nodes that aren’t all in one frame of type ‘gcp.region’: span only the nodes of one.
Nest the presets as Google does: gcp.cloud, gcp.project (optional), gcp.region, gcp.subnet, then gcp.tier and gcp.instanceGroup in a subnet or a Region, and gcp.onPremises outside every Google Cloud group. The check reads through generic frames: it compares a preset with the nearest preset round it. Write gcp.vpc round its subnets, and gcp.zone round the nodes of one zone in one Region, with spans, never children. To draw one written with children again, in one edit: deleteElement it, put what it held back in its Region, tier or subnet, and createFrame it again with spans. A node moves with updateNode and frame. A subnet is deleted and created again with createFrame, frame set to its Region and its nodes in children.
GCP_GROUP_UNTYPEDwarningSet this frame’s containerType to ‘{preset}’ if it is {a Google Cloud group}, or leave it generic.
Set this frame’s containerType to ‘{preset}’ and draw it round its {targets} with spans if it is {a Google Cloud group}, or leave it generic.
Set the frame’s containerType to the preset the message names, with updateFrame on a saved diagram, and it draws as Google draws that group. Leave the frame generic if it isn’t that group. A VPC or a zone takes spans, not children: deleteElement the frame and createFrame it again as gcp.vpc or gcp.zone with spans, and put what it held in its Region, tier or subnet (GCP_GROUP_NESTING says how). The warning comes only for a frame that holds gcp:* icons, when its title is a group’s own name, alone or with one identifier (a letter, or a word with a digit): VPC network, Region: us-east1, us-east1, Zone a, Subnet 10.0.0.0/20. A project takes only a word with a digit (Project: my-project-123). VPC Service Controls perimeter, Data landing zone, Project Atlas ingestion and Production project get none.
LAYER_HAS_LAYOUTinfoRemove the layout from layer ‘{id}’ so the engine arranges it in its stack. With a layout of its own it keeps that box and is placed as a generic frame; autoLayout without elements drops the layout.Info level: the API returns no warning for it. A layer with a layout of its own keeps that box and draws as a plain frame. To arrange it, write the layer without a layout. Or send autoLayout without elements: it places every node again and drops the layout of every frame but a pool, lane or fragment.
LAYER_NOT_ARRANGEDwarning or infoSet the diagram family to architecture, or write layer ‘{id}’ as a generic frame. Layers are arranged in architecture diagrams, and this scene’s family is ‘{family}’, so ‘{id}’ is placed as a generic frame.
Put the layers in a generic frame of their own, outside what arranges them. Layer ‘{id}’ is inside ‘{up}’, which the layout arranges its own way, so ‘{id}’ is placed as a generic frame.
List all the layers of a stack in one frame, or at the root. Only the first stack of a scene is arranged, so layer ‘{id}’, in another stack, is placed as a generic frame.
Put the layers in a generic frame of their own, outside what arranges them. Layer ‘{id}’ is beside cloud groups, which the layout arranges its own way, so ‘{id}’ is placed as a generic frame.
List layer ‘{id}’ beside the other layers to make it one of the stack. Inside layer ‘{up}’ it is a sub-group of that layer, placed as a generic frame.
Write the layers where the engine arranges them: in an architecture diagram, listed by one frame or at the root, outside any pool, lane or fragment. In an AWS or Google Cloud diagram, put the stack in a generic frame of its own, or in a cloud boundary that holds no Region; at the root, in a VPC, zone or subnet, or beside Regions, its layers are not arranged. Only the scene’s first stack is arranged. A layer inside a layer is a sub-group of it, at info level. Until then the frame is placed as any generic frame is.
SPAN_INVALIDerrorFrame ‘{id}’ has both children and spans: move its children into a frame of their own, or remove spans.
Spanning frame ‘{id}’ can span only nodes and frames other than spanning frames: remove {targets} from spans. Spanning frames don’t nest.
Spanning frame ‘{child}’ is listed in ‘{id}’: remove it from that {kind}‘s children.
Give a new frame spans or frame, not both: a spanning frame sits in no frame.
Give a new frame children or spans, not both: a spanning frame holds nothing and is drawn round what it spans.
Frame ‘{id}’ holds children, so it has no spans to change: create a spanning frame with createFrame and spans instead.
A spanning frame holds nothing and sits in nothing: give a frame children or spans, not both, give createFrame no frame with spans, and list it in no frame’s or group’s children. Its targets are nodes and frames other than spanning frames, so spanning frames don’t nest. updateFrame’s spans changes a spanning frame only; to draw a frame with children round other elements, create a new frame with spans.
SPAN_NOT_DRAWNwarningSpanning frame ‘{id}’ isn’t drawn in a {family} diagram: remove it, or draw the group as a frame with children when its targets are in no other frame. Spanning frames are drawn in architecture diagrams and diagrams without a family.Spanning frames are drawn in architecture diagrams and diagrams without a family only. Elsewhere, delete the spanning frame, or draw the group as a frame with children when its targets are in no other frame: an element in two frames’ children is MULTIPLE_FRAME_MEMBERSHIP. The diagram is saved either way, with the spanning frame kept and not drawn.

Layout

CodeSeverityMessageWhat to change
RELATIVE_SELF_REFERENCEerrorElement ‘{id}’ references itself in relative placement.Place the element relative to another element.
RELATIVE_TARGET_NOT_FOUNDerrorRelative placement target ‘{target}’ does not exist.Name an element that exists in place, or give the element an absolute layout.
INVALID_INSIDE_TARGETerror’inside’ target ‘{target}’ is ‘{kind}’, not a container (group, frame, or container node).inside takes a group, a frame or a container node. Point it at one, or use rightOf, leftOf, above or below.
INVALID_ELEMENT_DIMENSIONSwarningElement ‘{id}’ has zero-size dimensions.Give the element a width and height above 0, or set visible: false to hide it and the edges at it.
RELATIVE_LAYOUT_CYCLEerrorRelative layout cycle detected involving ‘{node}’.Break the chain: give one of its elements an absolute layout, or remove the relative layouts and let the engine place them.

Constraints

CodeSeverityMessageWhat to change
CONSTRAINT_ID_DUPLICATEerrorConstraint ID ‘{id}’ is used more than once.
Constraint ID ‘{id}’ is already in use.
Give each constraint its own id, or leave it out: removeConstraint removes a constraint by its id, so an ID names one constraint.
CONSTRAINT_TARGET_NOT_FOUNDerrorConstraint references nonexistent element ‘{id}’.
Constraint references nonexistent container ‘{id}’.
Name elements that exist, or remove the missing ones from the constraint. An order constraint’s message starts “Order constraint” and names its source or target.
ORDER_CONSTRAINT_SELF_REFERENCEerrorOrder constraint source and target are the same element ‘{source}’.Give the order constraint two different elements as source and target.
CONSTRAINT_INSUFFICIENT_MEMBERSwarningConstraint ‘{type}’ should have at least 2 elements, got {count}.List at least two elements, or remove the constraint.
CONSTRAINT_DUPLICATE_MEMBERwarningElement ‘{id}’ appears more than once in constraint.List each element once.
ORDER_CONSTRAINT_CYCLEwarningOrder constraints form a cycle through {cycleNodes}: remove one of them; until then the layout ignores those it can’t meet.Remove one of the order constraints in the loop. Until then the layout ignores the ones it can’t satisfy.
ORDER_CONSTRAINT_CONTRADICTIONwarningOrder constraints contradict: ‘{source}’ and ‘{target}’ have both sameRank and a directional ordering.Keep either the sameRank constraint or the directional one for the pair.

Images, text and icons

CodeSeverityMessageWhat to change
ASSET_NOT_FOUNDerrorAsset ‘{assetRef}’ referenced by image ‘{id}’ not found.Add the asset to the scene’s assets (in an edit, updateScene with assets), point assetRef at one that exists, or delete the image in the same edit.
ASSET_KIND_MISMATCHwarningImage ‘{id}’ references asset ‘{assetRef}’ of kind ‘{kind}’, expected ‘image’.Point assetRef at an asset whose kind is image.
EMPTY_TEXT_WARNINGwarningText element ‘{id}’ has empty text.
setText on ‘{id}’ sets empty text.
Give the element some text, or delete it.
ASSET_URI_POLICY_VIOLATIONwarningAsset ‘{asset}’ uses the remote URI ‘{uri}’: the SVG keeps it as a link most viewers don’t load, and PNGs leave it out.
‘{id}’ uses the remote URI ‘{icon}’ as its icon: the SVG keeps it as a link most viewers don’t load, and PNGs leave it out.
Embed the image as a data: URI, so every SVG and PNG of it shows the picture.
ICON_KEY_INVALID_FORMATwarningIcon key ‘{icon}’ does not match expected format ‘{family}:{identifier}’ (e.g. ‘lucide:database’).Use family:name, such as lucide:database or aws:lambda, or an image as a data: URI.
EDGE_ENDPOINT_KIND_INVALIDwarningEdge ‘{id}’ connects from ‘{kind}’ element ‘{element}’ which is not a connectable kind.Connect the edge to a node, a frame or a group; a guide, a text element or an image can’t be an edge’s end. An edge to a frame or group is drawn to its border.
SELF_LOOP_EDGE_WARNINGwarningEdge ‘{id}’ is a self-loop on element ‘{element}’.Point one end at another element, or keep the loop if it’s meant. Sequence self-messages and ER self-references aren’t warned.
LANG_INVALIDerrorScene lang ‘{lang}’ isn’t a BCP 47 language tag: use one such as ‘ja’, ‘ko’, ‘zh-Hans’, ‘zh-Hant’ or ‘zh-HK’, or remove it. Without lang, the language is inferred from the text.Set the scene’s lang to a BCP 47 tag such as ja, ko, zh-Hans, zh-Hant or zh-HK; in an edit, use updateScene. Or remove it (lang: null) and the language is inferred from the text (Scene schema).
FONT_FAMILY_UNKNOWNwarningfontFamily ‘{family}’ on {up to three places it is set} draws in the default font: use ‘sans’ or ‘mono’ (a monospace font), or remove it.
scene.defaults.fontFamily ‘{family}’ changes nothing: set fontFamily ‘sans’ or ‘mono’ on elements or in styles, and remove it from scene.defaults.
Set fontFamily to sans or mono, or remove it, everywhere the warning names; one warning covers each family. A family in scene.defaults is never drawn: remove it there.

Diagram family rules

CodeSeverityMessageWhat to change
AUTONUMBER_NOT_DRAWNwarningOnly a sequence diagram numbers its messages from autonumber: give the edges you want numbered a step instead, and remove autonumber.Give each edge you want numbered a step, and remove the document’s extensions.autonumber with updateScene and extensions: { autonumber: null }. Only sequence diagrams number their messages from autonumber; every family draws an edge’s step.
FAMILY_FLOWCHART_DECISION_FEW_EXITSwarningDecision ‘{decision}’ has {exits}: give it one exit for each answer, at least two, or make it a process.Add an edge from the decision for each answer, at least two. A step with one way out is a process: change its nodeType, and its shape if it sets diamond.
FAMILY_FLOWCHART_EXIT_UNLABELEDwarningExit ‘{edge}’ from decision ‘{decision}’ has no label: label it with the answer it stands for, such as yes or no.Set the edge’s label to the answer it stands for, such as yes or no, with updateEdge.
FAMILY_WORKFLOW_NO_STARTwarningWorkflow diagram has no start node: add a workflow.start or workflow.messageStart node.Add a workflow.start or workflow.messageStart node.
FAMILY_WORKFLOW_NO_ENDwarningWorkflow diagram has no end node: add a workflow.end, workflow.terminate or workflow.messageEnd node.Add a workflow.end, workflow.terminate or workflow.messageEnd node.
FAMILY_WORKFLOW_DECISION_FEW_OUTPUTSwarningGateway ‘{node}’ has {count} outgoing edge(s): give it at least two, or make it a workflow.task.Give the gateway a second outgoing flow, or make it a workflow.task.
FAMILY_WORKFLOW_TERMINATE_HAS_OUTGOINGwarningTerminate end event ‘{node}’ has outgoing edges: remove them, or make it a workflow.end.Remove the flows leaving the terminate event, or make it a workflow.end.
FAMILY_WORKFLOW_EVENT_GATEWAY_FEW_OUTPUTSwarningEvent-based gateway ‘{gateway}’ has {count} outgoing edge(s): give it one for each event it waits for, at least two.Give the event-based gateway an outgoing flow for each event it waits for, at least two.
FAMILY_ER_ISOLATED_ENTITYwarningER entity ‘{entity}’ has no connected edges.Connect the entity to another with an er.relationship edge, or remove it.
FAMILY_ER_MISSING_CARDINALITYwarningER edge ‘{edge}’ has no cardinality at {where}: set cardinality there, or anchor it at a column marked pk or fk so it’s inferred.Set cardinality on the end it names, or anchor that end at a pk or fk column with from.column or to.column so it’s inferred.
FAMILY_SEQ_NO_LIFELINESwarningSequence diagram has no participants: no lifeline, actor or other participant node.Add a participant: a sequence.lifeline, a sequence.actor or another participant type.
FAMILY_SEQ_ORPHAN_MESSAGEwarningSequence message ‘{edge}’ has an end that isn’t a participant.
Edge ‘{edge}’ has an end that isn’t a participant, so it isn’t a message and is drawn outside the message rows: join it to two participants, or remove it.
Connect both ends of the edge to participants: lifelines, actors or nodes of another participant type. Remove the edge if it isn’t a message.
FAMILY_SEQ_NO_MESSAGESwarningSequence diagram has participants but no messages.Add an edge between two participants. Set a sequence.* edgeType to choose its kind; with none, its line decides (Message rendering).
FAMILY_SEQ_EMPTY_FRAGMENTwarningCombined fragment ‘{frame}’ holds no messages or notes, so it isn’t drawn.
A frame that holds no lifeline, message or note isn’t drawn: add lifelines for a participant box, or messages and notes for a highlight band, or remove it. Frame ‘{frame}’ holds none of them.
List the messages and notes the fragment holds in its children (a ref too needs at least one), or remove the fragment. Any other frame of a sequence diagram is read by its children: participants make it a participant box, messages and notes a highlight band. Leave its layout off: it isn’t read.
FAMILY_SEQ_FRAGMENT_SPLITwarningFragment ‘{frame}’ holds ‘{first}’ and ‘{last}’ but not ‘{stray}’, which is drawn inside it.
A highlight band is drawn from its first row to its last: add each row between them to its children, or move those rows above or below the band. Band ‘{frame}’ holds ‘{first}’ and ‘{last}’ but not ‘{stray}’, which is drawn inside it.
Add each row between the first and the last to the children of the fragment or band, or of a fragment or band nested in it. Or move the row out of the span with updateEdge or updateNode and after or before.
FAMILY_SEQ_FRAME_MIXEDwarningA frame that holds both lifelines and messages or notes isn’t drawn: put the lifelines in one frame and the messages and notes in another, or remove it. Frame ‘{frame}’ holds lifeline ‘{lifeline}’ and row ‘{row}’.Put the lifelines in one frame and the messages and notes in another. The first is drawn as a participant box round their columns, the second as a highlight band behind those rows. A frame also holds what the frames inside it hold. Remove one that only wraps a box and a band: they are drawn without it.
FAMILY_SEQ_BOX_NESTEDwarningParticipant boxes don’t nest or overlap, and this box shares a lifeline with another, so it isn’t drawn: keep each lifeline in one box. Box ‘{box}’ shares lifeline ‘{lifeline}’ with box ‘{by}’, which is drawn.Keep each lifeline in one participant box, and no box inside another. Until then one of the two is drawn: the outer box when one is inside the other, otherwise the one earlier in elements.
FAMILY_SEQ_BOX_SPLITwarningA participant box is drawn from its first lifeline to its last: add each lifeline between them to the box, or move it out with updateNode and after or before. Box ‘{box}’ holds ‘{first}’ and ‘{last}’ but not ‘{stray}’, which is drawn inside it.Add each lifeline between the first and the last to the box’s children, or move it out from between the box’s lifelines with updateNode and after or before.
FAMILY_SEQ_OPERAND_NOT_FOUNDerrorOperand {n} of fragment ‘{id}’ starts at its first row ‘{startsAt}’; an operand starts at a later row, the first belongs to the fragment itself.
Operand {n} of fragment ‘{id}’ starts at ‘{startsAt}’, which isn’t a message or note in the fragment.
Set the operand’s startsAt to a message or note in the fragment’s children, after its first row.
FAMILY_SEQ_ACTIVATION_ANCHOR_NOT_FOUNDerrorActivation ‘{id}’ {field} ‘{anchor}’ isn’t a message in this diagram.Set startsAt and endsAt to message IDs in the diagram.
FAMILY_SEQ_ACTIVATION_ENDS_BEFORE_STARTwarningActivation ‘{act}’ ends at ‘{endsAt}’, which comes before ‘{startsAt}’, so it is drawn one row tall at ‘{startsAt}’.Set endsAt to a message at or after startsAt, or leave it out for a bar one row tall.
FAMILY_SEQ_NOTE_INVALID_ANCHORwarningA note with no anchor is drawn over the lifelines of the message above it, beside one of them with side: set extensions.anchor to a lifeline ID or IDs. Note ‘{note}’ has none.
Note ‘{note}’ has no extensions.anchor and the diagram has no lifeline to draw it on: add the lifelines, then set the anchor.
sequence.note ‘{note}’ extensions.anchor must be a string or string[]; got {type}.
Set the note’s extensions.anchor to the lifeline ID it belongs to, or to an array of two or more lifeline IDs for a note across them.
FAMILY_SEQ_NOTE_ANCHOR_NOT_FOUNDwarningsequence.note ‘{note}’ anchor ‘{anchor}’ is not a lifeline, an actor or another participant in this scene.Anchor the note to participants that exist.
FAMILY_SEQ_NOTE_SIDE_IGNOREDwarningA note across lifelines is drawn over them, so side does nothing: anchor the note to one lifeline to draw it beside that one, or remove side. Note ‘{note}’ spans {count} lifelines.Anchor the note to one lifeline, its ID as a string, to draw it beside that lifeline, or remove side. A note across two or more lifelines is always drawn over them.
FAMILY_SEQ_NOTE_ANCHOR_TOO_SHORTwarningsequence.note ‘{note}’ anchor array has length {count}; use one lifeline ID as a string for a note over that lifeline, or an array of two or more for a note across them.Use one lifeline ID as a string, or two or more in the array.
FAMILY_SEQ_USED_BEFORE_CREATEwarningA lifeline used above the message that creates it is drawn full height: move the create message above the lifeline’s first message or note, or make it a sequence.message. Lifeline ‘{lifeline}’ is used by ‘{row}’ above ‘{create}’.Move the sequence.create message above every message and note on the lifeline, with updateEdge and before, or change it to a sequence.message. A created lifeline starts at the message that creates it only when nothing above that message uses it.
FAMILY_SEQ_USED_AFTER_DESTROYwarningA lifeline used below the message that destroys it is drawn full height: move the destroy message below the lifeline’s last message or note, or make it a sequence.message. Lifeline ‘{lifeline}’ is used by ‘{row}’ below ‘{destroy}’.Move the sequence.destroy message below every message and note on the lifeline, with updateEdge and after, or change it to a sequence.message. A destroyed lifeline ends at the message that destroys it only when nothing below that message uses it.
FAMILY_ORG_NO_PEOPLEwarningOrg chart has no org.person or org.role nodes.Add org.person or org.role nodes.
FAMILY_UI_NO_SCREENSwarningUI flow diagram has no uiflow.screen nodes.Add uiflow.screen nodes.
FAMILY_UI_NO_ENTRYwarningUI flow diagram has no uiflow.entry node.Add a uiflow.entry node where the flow starts.
FAMILY_UI_ORPHAN_SCREENwarningScreen ‘{screen}’ has no connected edges.Connect the screen to the flow with an edge, or remove it.

Operations (edits only)

CodeSeverityMessageWhat to change
OP_ID_ALREADY_EXISTSerrorElement ID ‘{id}’ already exists in scene or was created earlier in this batch.Use a new ID, or change the existing element with updateNode or updateEdge.
OP_TARGET_NOT_FOUNDerrorTarget element ‘{id}’ does not exist.
Frame ‘{frame}’ doesn’t exist when this op runs: name a frame that exists, or create it with createFrame in an earlier op.
Element ‘{target}’ in spans doesn’t exist and no op in this edit creates it: create it, or leave it out.
Read the diagram again for its current IDs, or create the element earlier in the same ops. The frame a createNode or updateNode frame names must exist when the op runs, so create it in an op before this one. A spanning frame’s spans may name an element any op of the same edit creates.
OP_TARGET_KIND_MISMATCHerrorOperation ‘{op}’ expects target kind ‘{expectedKind}’ but ‘{id}’ is ‘{kind}’.
Operation ‘{op}’ expects frame ‘{frame}’ to be kind ‘frame’ but it is ‘{kind}’: name a frame, such as a pool or lane, or leave frame out.
Use the operation for the element’s kind: updateNode for a node, updateEdge for an edge, updateFrame for a frame, ungroupElements for a group. autoLayout places nodes only, so its elements lists node IDs. The frame of createNode and updateNode names a frame, not a group or a node.
TEXT_OPERATION_KIND_INVALIDerrorsetText not supported on element kind ‘{kind}’.setText changes nodes, edges and text elements only.
RESIZE_NOT_SUPPORTEDerrorresizeElement not supported on element kind ‘{kind}’.
resizeElement can’t resize ‘{id}’: the engine sizes a sequence diagram’s {kind}s from their labels and messages.
resizeElement can’t keep a side of ‘{id}’ in place, because it is placed relative to another element: leave anchor out.
resizeElement changes nodes, frames, images and text elements, but not a sequence diagram’s nodes and frames. For an element placed relative to another, leave anchor out.
MOVE_NOT_SUPPORTEDerrormoveElement not supported on element kind ‘{kind}’.
moveElement can’t move ‘{id}’: the engine lays out a sequence diagram’s {kind}s from its messages.
Move what the edge connects instead: the engine routes an edge between its ends. In a sequence diagram the engine lays out the nodes and frames from the order of lifelines and messages: move one with updateNode or updateEdge and after or before.
MOVE_NOT_ALLOWED_FOR_RELATIVE_LAYOUTerrorCannot move element ‘{id}’ which has relative layout.Change a node’s layout with updateNode instead of moving it. A frame, text or image element placed relative to another follows it, so move that element.
STYLE_OPERATION_NO_EFFECTwarningsetStyle on ‘{id}’ has no effect: its style is already ‘{style}’.Drop the operation: the element already has that style.

Fields 7.0.0 removed

Node ports and an endpoint’s portId were removed in 7.0.0. A scene or an edit that sets them is saved without them, with a warning for each that said something. The empty ports every node saved before 7.0.0 carries is dropped with no warning when it is sent, so a diagram read with view=dsp and sent back still validates. Read, such a version still has ports: [], which the published 7.0.0 schemas don’t accept, so check it as Schema describes; an edit saves a version without it. Place an end with its endpoint’s anchor instead (Element types: Edges).

CodeSeverityMessageWhat to change
PORTS_REMOVEDwarningNode ‘{element}’ sets ports, which 7.0.0 removed: place an edge’s end with from.anchor or to.anchor ({ side } or { side, offset }).
Edge ‘{edge}’ sets {end}.portId, which 7.0.0 removed: place the end with {end}.anchor ({ side } or { side, offset }).
Remove ports from the node and portId from the edge’s ends, and place an end with the edge’s from.anchor or to.anchor ({ side, offset }). The API drops both fields and saves the rest; an empty ports, as diagrams saved before 7.0.0 carry, gets no warning.

What drawing notices

A valid scene is also laid out and drawn, when it is checked, saved or edited. These warnings come from that drawing, and their fix gives the figures you need.

CodeSeverityMessageWhat to change
NODE_OUTSIDE_FRAMEwarningIt sits outside frame ‘{frame}’, which doesn’t grow to fit it: move it inside with updateNode, or enlarge ‘{frame}’ with resizeElement.Move the node inside the frame with updateNode, or enlarge the frame with resizeElement; moving a frame moves its members with it. A frame with its own layout keeps that size for nodes placed outside it; it grows only when a member the engine grows or pushes crosses its border. One written without a layout grows to fit its children, and pools and lanes always grow to hold their members, so they never get this warning. In an architecture diagram, when the frame has a sibling generic frame, the fix ends with a clause for sibling frames that are rows of one stack: set containerType: "layer" on each with updateFrame, then send autoLayout without elements (Layout engine: Layers).
FRAME_OVERLAP_DETECTEDwarningIt overlaps frame ‘{other frame}’: place one frame’s nodes again with autoLayout and elements, or move them with updateNode (a frame with its own layout with moveElement). autoLayout without elements lays the whole diagram out again, each frame round its own nodes, and drops every frame’s own layout but a pool’s, lane’s or fragment’s.
It overlaps frame ‘{other frame}’: place one frame’s nodes again with autoLayout and elements, or move them with updateNode (a frame with its own layout with moveElement).
Send autoLayout with elements naming the nodes of one of the two frames, and the engine places them again clear of the other; or move them with updateNode. A frame written without a layout is fitted to its nodes and moves with them; one with its own layout keeps its box (it grows only when a member the engine grows or pushes crosses its border), so move it with moveElement or change its size with resizeElement. In an architecture, flowchart, workflow, entity-relationship or UI flow diagram, or one without a family, autoLayout without elements also lays the diagram out again with each frame round its own nodes, but it drops the layout of every frame but a pool, lane or fragment, and places every node again but the members of a pool, lane or fragment with its own layout. Pools never get this warning with each other: the engine keeps pools that share columns at least 40 px apart. The first message comes in those families, the second in org charts and networks, whose layouts ignore frames.
NODE_IN_WRONG_FRAMEwarningIt lies inside frame ‘{frame}’ but isn’t a member: send autoLayout with elements: [“{node}”] to place it again, or move it with updateNode. autoLayout without elements lays the whole diagram out again, each frame round its own nodes, and drops every frame’s own layout but a pool’s, lane’s or fragment’s.
It lies inside frame ‘{frame}’ but isn’t a member: send autoLayout with elements: [“{node}”] to place it again, or move it with updateNode.
Send autoLayout with elements naming the node, and the engine places it again outside the frames it isn’t a member of; or move it with updateNode. In an architecture, flowchart, workflow, entity-relationship or UI flow diagram, or one without a family, autoLayout without elements also lays the diagram out again with each frame round its own nodes, but it drops the layout of every frame but a pool, lane or fragment and places every node again but the members of a pool, lane or fragment with its own layout. The first message comes in those families, the second in org charts and networks, whose layouts ignore frames. In an architecture diagram, when the frame has a sibling generic frame, the fix ends with a clause for sibling frames that are rows of one stack: set containerType: "layer" on each with updateFrame, then send autoLayout without elements (Layout engine: Layers).
LABEL_DUPLICATION_DETECTEDwarningEdges {edges} share the label ‘{label}’: merge them or give each its own label.Give one of the edges a more specific label with updateEdge, such as “route to users” instead of “route”, or merge the edges. Sequence diagrams don’t get this warning: their messages repeat labels at different times.
NODE_OVERLAP_DETECTEDwarningIt overlaps ‘{other node}’: send autoLayout with elements: [“{node}”] to place it again, or move one of them.Fires when the engine can’t make room: coordinates an agent wrote, or an overlap already in the document. Send autoLayout with elements naming one of the two nodes, and the engine places it again in free space; or move one of them with updateNode. When one of the two is drawn bigger than its layout to fit its content, the fix names it and both sizes before that advice.
SPAN_COVERS_NODEwarningIt is drawn over {nodes}, which it doesn’t span: add {it or them} to its spans, or span only targets that sit together.Add the covered nodes to the frame’s spans with updateFrame when they belong in it, or span only targets that sit together. autoLayout places every node again with a margin round each target, which clears a node pressed against one but not one between two; in an AWS diagram the room it keeps is for the header, in a VPC’s rows. The fix names up to three nodes (Rendering: SPAN_COVERS_NODE).
EDGE_CROSSES_NODEwarningIt runs through ‘{node}’, which it doesn’t join: set router: “orthogonal”, or leave router off, and the engine routes it round nodes; or move ‘{node}’ off its line.A straight or curved edge keeps the shape you set and isn’t routed round nodes (Rendering: Edge routing). Set router: "orthogonal" with updateEdge, or leave router off, and the engine routes it round them; or move the node with updateNode. A lone curved edge already bows to the side that clears nodes where one does; curves between one pair of nodes keep their lens.
EDGE_OFFSET_ON_GROWN_NODEwarningIt is drawn {drawn} px {wide or high}, more than the {declared} its layout gave it, so an offset on its {sides} side ({edges}) is a fraction of {drawn}. Restate the offset against {drawn}, or give the end’s anchor the side alone.An edge end pins an offset on a side of a node that is drawn bigger than its layout gave it, to fit its label or icon (Rendering: EDGE_OFFSET_ON_GROWN_NODE). A save stores the drawn size, so restate the offset against it with updateEdge, or give the end’s anchor the side alone and the engine places the end. The warning names an offset only on the side that grew. A node whose edges dock on a smaller box than it draws (the list) gets no such warning.
POOL_FLOW_DIRECTIONwarningPool ‘{pool}’ stacks its lanes {stacking}, so the flow runs {direction}, not {asked}: for {asked}, set its laneDirection to “{other}” or leave it out. Lanes always run across the flow, as BPMN draws them.
Pool ‘{pool}’ stacks its lanes {stacking}, but the flow runs {direction}, so they run across it instead: set its laneDirection to “{other}” or leave it out. An earlier pool’s laneDirection set the flow.
Lanes always run along the flow and stack across it, so a pool’s laneDirection sets the flow (Layout engine: Pools and lanes). For the flow layoutStrategy.direction asks for, set the pool’s laneDirection to the value the fix names ("vertical" for LR or RL, "horizontal" for TB or BT), or leave laneDirection out and the lanes stack across the scene’s direction. Lanes along the flow, such as phases, aren’t supported.
CHARACTER_NOT_DRAWNwarning{count} characters can’t be drawn and appear as boxes ({up to five of them}), in {up to three elements}: write the text in Latin, Cyrillic, Greek, Armenian, Georgian or common Chinese, Japanese or Korean characters, or keep the text and accept the boxes.
1 character can’t be drawn and appears as a box ({character}), in {up to three elements}: write the text in Latin, Cyrillic, Greek, Armenian, Georgian or common Chinese, Japanese or Korean characters, or keep the text and accept the boxes.
Rewrite the named elements’ text in Latin, Cyrillic, Greek, Armenian, Georgian or common Chinese, Japanese or Korean characters, or keep the text and accept the boxes. One warning covers the whole diagram (Rendering: CHARACTER_NOT_DRAWN).
TEXT_OVERFLOWwarningIts text needs about {required height}px of height and has {available height}px: make it taller or wider, or wrap the text.Make the element as tall as the fix says, or wider, or wrap its text with textStyle.wrap: "word"; layout.autoSize: "content" sizes a wrapped node. A frame’s title that is too wide gets “Its title needs about {required width}px of width and has {available width}px: widen it to {required width}px with resizeElement, or shorten the title with updateFrame.” (Rendering: TEXT_OVERFLOW).
ICON_NOT_FOUNDwarningIts icon ‘{icon}’ isn’t registered: did you mean {up to three keys spelled like it}? Otherwise use an image as a data: URI.Set the node’s icon with updateNode (a frame’s with updateFrame) to a registered key or an image as a data: URI, or remove it with icon: null. The fix names up to three keys or aliases of the same family spelled like the one you sent, else up to three whose name or keywords hold its words (aws:queue names aws:sqs), else the families there are. Element types: Icons lists the Lucide keys and the AWS and Google Cloud keys used most, and AWS icon keys and Google Cloud icon keys list every key. Until then the node keeps the icon’s room, empty (a Google Cloud node still draws its card), and a frame draws no icon in its header.
DRAW_TIMEOUTwarningDrawing this scene took longer than {budget}, the budget without a key or sign-in, so drawing warnings weren’t checked. A save draws it again within the signed-in budget, {signed-in budget}.
Drawing this scene took longer than {budget}, so drawing warnings weren’t checked. A save draws it again within the same budget. Split the diagram, or draw fewer edges into one node.
Drawing this scene needed more memory than a drawing gets, so drawing warnings weren’t checked. A save draws it again with the same memory. Split the diagram, or draw fewer edges into one node.
Drawing has a budget: 5 seconds for a check without a key or sign-in, 20 seconds with one and for every save, and the same memory for every drawing. Check it with a key or signed in for the larger time budget. A save past either limit is refused, so make the diagram smaller or less dense, such as a hub with fewer leaves, or split it into several.

Laying out a scene notices more than this, such as a canvas it had to grow. The engine handles those cases itself, and the API doesn’t return them; Rendering: Render diagnostics describes what it does.

When an edit can’t be applied

An edit that passes the rules can still fail when it runs. The element an operation changes must exist when it runs. What an operation only names (an edge’s ends, a group’s or frame’s children, a spanning frame’s spans, a style, a relative layout’s target, a constraint’s elements) must exist already or be created by a later operation in the same edit; the element after or before names, and the frame a createNode or updateNode frame names, must exist when the operation runs. An operation that names something nothing creates returns the code the rules above give it, at the operation’s index. These come back in errors with 422 VALIDATION_FAILED, and nothing is saved.

CodeSeverityMessageWhat to change
RESTORE_NOT_ALONEerrorrestoreRevision must be the only operation in its edit.Send restoreRevision in an edit of its own, or use the edit’s restoreRevision argument instead of ops.
RESTORE_REVISION_INVALIDerrorrestoreRevision needs a revision number (1 or more).Give the restoreRevision operation a revision number of 1 or more, or an asOf date to restore the revision current then.
REVISION_NOT_FOUNDerrorRevision {target} of scene ‘{scene}’ not found.Restore a revision that exists: diagram_history lists them.
RESIZE_NOT_PLACEDerrorNode ‘{id}’ isn’t placed yet, so the engine gives it the size its content needs when it places it: resize it in a later edit.
Frame ‘{id}’ fits its members and isn’t drawn yet, so it has no size to change: resize it in a later edit, or give it a layout when you create it.
Resize it in a later edit, after the engine places the node or draws the frame. To size a new node now, create it with a layout that has a position.
OP_APPLY_FAILEDerrorTarget element ‘{id}’ not found for operation ‘{op}‘Read the diagram again for its current IDs and send the edit with the new baseRevision.
ORDER_NOT_SUPPORTEDerror’{id}’ is a {type}, which isn’t drawn by its order: only a sequence diagram’s participants, messages and notes take ‘{after or before}’.
‘{id}’ can’t be placed next to itself.
‘{id}’ is a {participant | message or note}, so ‘{after or before}’ names {what it can name}; ‘{other}’ is a {kind}.
Place a participant next to another participant, and a message or note next to another message or note, a fragment or a highlight band. Leave after and before out for any other element: its place in the array draws nothing.
ORDER_TARGET_NOT_FOUNDerror’{id}’ doesn’t exist when this op runs; name an element that exists, or make it in an earlier op.Name an element that exists in after or before, or create it in an op before this one: where it is decides where this element goes.

A stale baseRevision, a reused requestId and a missing diagram have error codes of their own: REVISION_CONFLICT, REQUEST_ID_REUSED and NOT_FOUND. REST API: Errors lists them.

Notes on a saved edit

A saved edit adds a note to warnings when a deleteElement, or a move with after or before, changes something its operations didn’t name: a constraint it removed (CONSTRAINT_REMOVED), an element that was placed relative to the deleted one (RELATIVE_LAYOUT_FIXED), a sequence fragment’s operand left with no rows (FRAGMENT_OPERAND_REMOVED), an activation bar left with no message to start at (ACTIVATION_REMOVED), or a spanning frame left spanning nothing (SPAN_REMOVED). Other changes an edit makes on its own get no note: an operand or bar moving to the next row when its own is deleted or moved, the edges at a deleted element go with it, a frame’s members move with it, and a node that grows pushes the nodes in its way. The edit’s changed names every element it added, updated or removed. Notes need no fix.

CodeMessageWhat to change
SPAN_REMOVEDSpanning frame ‘{id}’ spanned only what was deleted, and was removed with it.Nothing to change. A spanning frame left spanning nothing is deleted, with its edges. Create it again with createFrame and spans if you still want it.
RELATIVE_LAYOUT_FIXED’{id}’ was placed relative to ‘{anchor}’, which was deleted, so it keeps its place with an absolute layout.Nothing to change. The element was placed relative to the deleted one, so it now has an absolute layout at the box it was last drawn with, and stays where it is. One that hadn’t been drawn yet is placed by the engine.
CONSTRAINT_REMOVED{constraint} named ‘{id}’, which was deleted, and was removed with it.Nothing to change. A constraint that names a deleted element as its container, source or target goes, and so does one left with fewer elements than it needs (two, or one for contain and centerIn); any other loses the deleted element. Add a new one with addConstraint if you still want it.
FRAGMENT_OPERAND_REMOVEDFragment ‘{id}’ has no rows left in its operand {operand}, so the operand was removed.
Fragment ‘{id}’ has no rows left in its first operand ‘{title}’, so the operand was removed and {operand} opens the fragment.
Fragment ‘{id}’ has no rows left, so its operands were removed.
Nothing to change. An operand starts at its first message or note, so deleting or moving that row starts it at its next one; an operand left with no rows goes, and when that is the first, the next opens the fragment with its guard as the frame’s title. To have the operand back, delete the fragment and create it again with createFrame in one edit.
ACTIVATION_REMOVEDActivation ‘{id}’ started at ‘{startsAt}’, which was deleted, and no later message before its end arrives at ‘{lifeline}’, so it was deleted too.Nothing to change. A bar whose first message is deleted starts at the next message, up to its last, that arrives at its lifeline; with none, it goes. Create a sequence.activation with startsAt (and endsAt) to have one again.

Mermaid notes

A create, check or edit sent as Mermaid adds a note to warnings for each part of the text that Zindex draws differently or leaves out. None of them blocks a save.

CodeMessageWhat to change
FENCE_USEDThe first ```mermaid block in the text was used.Nothing to change. Send the Mermaid alone to drop the note.
COMMENT_NOT_SHOWNAttribute comments on {name} are kept but not drawn.Nothing to change: the comment stays with the column.
CONSTRUCT_DROPPED{what} was left out: {why}Point the edge at a declared entity, or at a node inside the subgraph instead of the subgraph. Invisible links (~~~) are always left out. A sequence diagram’s links, empty blocks and boxes, an activate with no deactivate or with no later message arriving at its lifeline, decimal numbers and numbers above 99 that can’t be autonumber are left out, and the participants and messages they hold are kept. In a view=mermaid read the same code names what has no Mermaid form and stays in the diagram: text, image and guide elements, spanning frames, and in a sequence diagram any edge that isn’t a message and any node or frame that isn’t a participant, note, bar, fragment, participant box or highlight band.
CARDINALITY_APPROXIMATEDThe cardinality {cardB}/{cardA} isn’t drawn exactly; the engine infers it from the columns instead.Nothing to change, or set the edge’s cardinality with updateEdge after saving.
SHAPE_APPROXIMATEDMermaid shape ‘{shape}’ is drawn as {nodeType}.
Mermaid participant type ‘{type}’ is drawn as a lifeline.
Nothing to change. To draw a flowchart node another way, set its shape with updateNode after saving. A sequence participant’s @{ "type" } isn’t one Mermaid draws, so it is a lifeline: if a participant type fits, set the node’s nodeType with updateNode after saving. In a view=mermaid read the same code means a shape Mermaid lacks was written as a rectangle (“Shape ‘{shape}’ is written as a rectangle.”); the node keeps its shape.
LABEL_MARKUP_REMOVEDHTML or Markdown in the label was removed.Write the label as plain text.
ARROW_APPROXIMATEDMermaid arrow ‘{type}’ is drawn with a {end} end.Nothing to change, or set the edge’s endpoints with updateEdge after saving.
SUBGRAPH_DROPPEDSubgraph ‘{subgraph}’ was left out; its {count} nodes were kept. Zindex doesn’t draw Mermaid subgraphs yet.Nothing to change: the nodes are kept. To group them, add a frame with createFrame after saving.
STYLE_DROPPEDMermaid styles (style, classDef, class) were left out; set styles on the elements instead.Style the elements with setStyle after saving.
CONSTRUCT_APPROXIMATED’{participant}’ is destroyed as it sends ‘{message}’, and Zindex ends a lifeline only where a message arrives at it, so the message was kept and the lifeline runs on.
A bar starts at a message that arrives at its lifeline, so the activation of ‘{lifeline}’ starts at ‘{message}’.
A `par_over` block is drawn as `par`.
Nothing to change. To end a lifeline that sends, add a destroy message to it; to start a bar at another message, set its startsAt with updateNode after saving. In a view=mermaid read of a sequence diagram the same code names what the text holds differently, which the diagram keeps as it is: a create message that isn’t its lifeline’s first row, a created participant’s column, overlapping bars written nested, a participant box whose lifelines aren’t side by side, are created later or are also in another box, a highlight band’s title, or a fill that isn’t a color.
AUTONUMBER_FIXEDThe numbering turns off, or changes how it counts, partway down, so each numbered message keeps its number as its step, and an edit doesn’t renumber them.Nothing to change. To have edits renumber the messages, remove each message’s step (updateEdge with step: null) and set the document’s extensions.autonumber with updateScene.
FRAMES_NOT_CHANGEDA Mermaid edit doesn’t change frames or groups yet, so the subgraph changes to {named}{more} were not made. Change frames with ops (createFrame, groupElements, deleteElement).
A Mermaid edit doesn’t change fragments Mermaid has no block for, or the blocks round them, so the changes to {named}{more} were not made. Change them with ops (createFrame, updateFrame, deleteElement).
A Mermaid edit reads `rect rgba(128, 128, 128, 0.1)` as a fragment Mermaid has no block for, so the rect in that color was not made. Write the color another way, such as `rgba(128,128,128,0.1)`, or use createFrame.
Change frames and groups with operations (createFrame, groupElements, deleteElement). A Mermaid edit leaves them as they are. In a sequence diagram the same code names a fragment written as a rect block, or a fragment that holds one, whose rows the text changed: change those with createFrame, updateFrame and deleteElement. It also names a rect rgba(128, 128, 128, 0.1) the text adds, which is how such a fragment is written: for a highlight band in that color, write it without the spaces.

Notes on a Mermaid view

A read with view=mermaid returns notes of the same shape in notes, one for each part of the diagram that Mermaid shows differently or can’t show. SHAPE_APPROXIMATED, CONSTRUCT_DROPPED and CONSTRUCT_APPROXIMATED come back here too, with the meanings the table above gives them for a view.

CodeMessageWhat to change
STEPS_NOT_EXPORTEDNumbered steps have no Mermaid form and aren’t written. A Mermaid edit keeps them; change them with updateEdge.
Step texts have no Mermaid form and aren’t written. A Mermaid edit keeps them; change them with updateEdge.
Nothing to change. A flowchart or erDiagram has no numbered steps, so the text leaves out each edge’s step and stepText; a sequenceDiagram writes a message’s step as autonumber lines and leaves out only stepText. A Mermaid edit keeps what the text leaves out, and updateEdge changes it.
FAMILY_NOT_EXPORTEDThis {family} diagram’s Mermaid names neither its family nor its node types, so a diagram created from the text is a flowchart; edit this diagram with ops.
This architecture diagram’s Mermaid names neither its family nor its node types, so a diagram created from the text is a flowchart; a Mermaid edit keeps this diagram’s family.
This diagram has no family and is drawn as architecture; its Mermaid doesn’t name its node types, so a diagram created from the text is a flowchart; a Mermaid edit leaves this diagram without a family.
Nothing to change. The diagram keeps its family; only a new diagram made from the text is a flowchart. Change a workflow, UI flow, org chart or network diagram with operations; an architecture diagram, or one with no family, also takes the text as a Mermaid edit.
FRAMES_READ_ONLYFrames and groups are written as subgraphs. A Mermaid edit leaves them as they are; change them with ops.
Fragments Mermaid has no block for ({fragments}) are written as rect blocks. A Mermaid edit leaves them as they are; change them with ops.
Nothing to change. Change frames and groups with operations; a Mermaid edit leaves them as they are. In a sequence diagram the same code names the fragments written as rect blocks: those whose operator has no Mermaid block, and a loop, opt or break with operands.
LABEL_NOT_EXPORTEDThe label ‘{label}’ differs from the entity name and isn’t written; the entity is named by its ID.Nothing to change. The entity keeps its label; Mermaid names it by its ID.
CARDINALITY_ASSUMEDNo cardinality was set, so the relationship is written as one-to-many.Nothing to change, or set the edge’s cardinality with updateEdge so Mermaid shows it.