import_source

TL;DR

What it does

Workflow. Turns a file into a finished diagram in one call: a database schema, an API spec, infrastructure as code, manifests, a software catalog, a CI workflow, CSV or JSON data, a folder listing, or a git log. get_diagram_syntax with topic import-formats says what each format reads, draws, and takes. Prefer it to drawing by hand whenever the person has such a file: send its text, never a path, or every file of a folder in files. Returns the source, diagnostics pointing into the file for anything left out, coverage, parts (every diagram of a split file), the validation, an outline, viewUrl, and saveCommand. It runs no code and reads no file or URL. Replaces validate_diagram and outline_diagram.

Steps

One call performs at most 26 operations.

Example call

The arguments of the call, as JSON:

1{2  "format": "compose",3  "text": "services:\n  api:\n    build: ./api\n    ports: [\"8080:8080\"]\n    depends_on: [db, cache]\n  db:\n    image: postgres:16\n  cache:\n    image: redis:7\n"4}

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

services:  api:    build: ./api    ports: ["8080:8080"]    depends_on: [db, cache]  db:    image: postgres:16  cache:    image: redis:7

Prompts that lead to it

• Draw our database schema from this SQL.
• Make a diagram of this docker-compose file.
• Which roles can call which endpoints in this OpenAPI spec?
• Chart this CSV.

Arguments

Result

Behavior hints

Bounds

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

See also