OAS 3.1 Diagrams
This directory contains generated SVG diagrams for the OAS 3.1 support decision documentation.
Diagram Inventory
Referenced in Documentation
| Diagram | File | Size | Referenced In | Purpose |
|---|---|---|---|---|
| OAS 3.1 Decision Tree | oas-migration-decision-tree.svg | 25.2 KB | OAS-3.1-SUPPORT.md | Visual decision tree showing which OAS 3.1 features to support (SUPPORT/DEFER/DISCOURAGE) |
| Webhooks vs EDA Comparison | combine-webhooks-eda.svg | 28.8 KB | OAS-3.1-WEBHOOKS.md | Comparison matrix of webhooks vs event-driven architecture patterns |
| Consumer Runtime Flow | consumer-runtime-flow.svg | 11.0 KB | OAS-3.1-WEBHOOKS.md | Complete authentication & delivery flow (8 steps) for webhook callbacks |
Additional Diagrams (Future Use)
| Diagram | File | Size | Purpose | Status |
|---|---|---|---|---|
| Webhook Support - Sequence Diagram 1 | should-we-support-webhooks-oas-3.1-diagram-1.svg | 21.7 KB | Alternative sequence diagram for webhook flow | Candidate for consolidation |
| Webhook Support - Sequence Diagram 2 | should-we-support-webhooks-oas-3.1-diagram-2.svg | 24.1 KB | Alternative platform architecture diagram | Candidate for consolidation |
| Webhook Support - Sequence Diagram 3 | should-we-support-webhooks-oas-3.1-diagram-3.svg | 26.0 KB | Alternative workflow diagram | Candidate for consolidation |
Diagram Philosophy
- Source Code: Mermaid diagram definitions are embedded directly in markdown files, not stored separately
- Generated Images: SVG files in this directory are the rendered output from those mermaid definitions
- Image References: Markdown files use image syntax to reference SVG files:
Maintenance Guidelines
- Do NOT add .mmd files to this directory - keep mermaid source in markdown files only
- Generate SVGs when needed using:
mermaid-cli(local installation)- Online mermaid editor at https://mermaid.live
- VS Code Mermaid extension
- Replace SVG files with newly generated versions after updating markdown diagrams
- Document new diagrams in the inventory table above
Future Work
- Consider consolidating the three “webhook-support” diagrams (1, 2, 3) into a single authoritative diagram
- Generate PNG versions for better email/document embedding
- Create a diagram generation workflow (e.g., CI/CD pipeline to regenerate SVGs from mermaid sources)
- Add diagram captions/alt text for accessibility
Last Updated: 2026-02-16
Total Size: ~176 KB (6 SVG files)