draw_diagram

TL;DR

What it does

Workflow. Checks, describes, and draws a diagram. With errors it returns each one with line, column, and a fix hint and draws nothing: fix the source and call again. When valid it returns the quality warnings (take the icon and group-type suggestions), an outline to check the meaning, the size, and the SVG for light, dark, or both. The pictures are most of an answer and you cannot see them: pass svg "never" to check, and draw only to save, show, or publish. Give viewUrl to the person, even after svg "never"; pngUrl and svgUrl download it; saveCommand, when given, saves it in a repository. A big drawing (about 30 nodes) loses its SVGs, dark first, and picturesOmitted says so; svg "always" forces them. Set embedSource true to save an SVG in a repository or publish one to edit later, so read_diagram gives the source back (anyone with the file can read it). detail "full" adds the whole outline. To change an existing diagram use edit_diagram, or read_diagram for a picture. Saves no file; never throws on bad source. Replaces the validate_diagram, outline_diagram and render_diagram calls.

Steps

One call performs at most 4 operations.

Example call

The arguments of the call, as JSON:

1{2  "source": "flow \"Login\" direction=right\nnode user person \"User\"\nnode api service \"Auth API\"\nnode db database \"Users DB\"\nuser -> api : \"POST /login\"\napi -> db : \"look up user\"",3  "themes": "both"4}

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

1flow "Login" direction=right2node user person "User"3node api service "Auth API"4node db database "Users DB"5user -> api : "POST /login"6api -> db : "look up user"

Prompts that lead to it

• Draw a diagram of how a user signs in through an API that checks a database.
• Check this diagram and draw it in light and dark.

Arguments

Result

Behavior hints

Bounds

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

See also