edit_diagram

TL;DR

What it does

Workflow. Changes diagram source with typed operations, on every kind, and checks the result. Each op and its fields: rename (target, to: an id everywhere it is used, or a label), set (target, or from and to for an edge, or target "header"; option, value, null removes it), add_node (id, label, type, options; into a block or after a statement; statement for a whole line), remove (target, with its block and edges), add_edge (from, to, label, arrow, options), remove_edge (from, to, label), move (target, into: a block, or null for the top level), replace_text (find, replace, all). Untouched lines keep their comments and layout. Each op reports applied, or why not with a hint, and a failed one is skipped. svg "never" (the default) lays nothing out; auto or always draws as draw_diagram does, with viewUrl and saveCommand. Replaces rewriting the source by hand and the draw_diagram check.

Steps

One call performs at most 4 operations.

Example call

The arguments of the call, as JSON:

1{2  "source": "flow \"Login\" direction=right\n# the sign-in path\nnode user person \"User\"\nnode api service \"Auth API\"\nnode db database \"Users DB\"\nuser -> api : \"POST /login\"\napi -> db : \"look up user\"",3  "operations": [4    {5      "op": "rename",6      "target": "api",7      "to": "gateway"8    },9    {10      "op": "set",11      "target": "db",12      "option": "icon",13      "value": "simple:postgresql"14    },15    {16      "op": "add_node",17      "id": "cache",18      "type": "database",19      "label": "Session cache"20    },21    {22      "op": "add_edge",23      "from": "gateway",24      "to": "cache",25      "label": "store session"26    }27  ]28}

The source argument, written out one line at a time:

1flow "Login" direction=right2# the sign-in path3node user person "User"4node api service "Auth API"5node db database "Users DB"6user -> api : "POST /login"7api -> db : "look up user"

Prompts that lead to it

• Rename the Auth API node to gateway and add a session cache it writes to.
• Move the database into the data group and remove the old queue.

Arguments

Result

Behavior hints

Bounds

A bound that is reached is reported in the result; nothing is cut silently.

See also