Output reference
All paths below are relative to the directory supplied with --output.
| Path | Content | Existing file behavior |
|---|---|---|
asyncapi.md |
Main Markdown page with metadata, servers, applications, operations, and examples. | Overwritten. |
asyncapi.puml |
Pipeline overview source. | Overwritten. |
docs/diagrams/src/c4/components/EDA/<application>.puml |
One application's operations and channel examples. | Overwritten. |
docs/diagrams/src/c4/components/EDA/<message>.puml |
Payload class diagram, named by defaultMessage.name. |
Skipped if the target already exists. |
The application filename comes from the key in x-applications. The message filename comes from each operation's default message. If multiple operations share a message name, the first written diagram wins. Existing payload files are skipped on later runs even when the schema changes. Files for removed applications or messages are not deleted.
Application and payload files share a directory. A collision between their names can overwrite or suppress a diagram; choose distinct names.
Image paths
No SVG files are generated by AsyncAPI Mate. The Markdown template contains relative links such as:
../../../diagrams/out/c4/components/EDA/asyncapi.svg
../../../diagrams/out/c4/components/EDA/<application>.svg
../../../diagrams/out/c4/components/EDA/<message>.svg
Those links assume the page will live at docs/c4/components/EDA/asyncapi.md. The CLI currently writes it at the output root, so placing the page and rendered diagrams in a site requires an integration step. See Integrate the output.
Diagram hyperlinks
Pipeline and application diagram links currently target asyncapi_events.html with operation anchors. That filename differs from the generated asyncapi.md, and the Markdown headings do not explicitly define the reference-derived anchors. These hyperlinks are not guaranteed to resolve, even after arranging the image files. Correct the links and anchors in your publishing process if clickable operations are required.
Template selection
The command uses bundled Jinja templates for Markdown, the pipeline overview, applications, and payload schemas. It exposes no template override option. Markdown and PlantUML output preserve literal syntax rather than applying HTML escaping.