YAML documents, end to end
Import a YAML OpenAPI spec and it stays YAML — through editing, snapshots and export. No more round-tripping your document through JSON just to use the editor.
In this release
- New
Read and write YAML documents
A YAML spec keeps its format through editing, snapshots and export. JSON documents are untouched, and you can still switch format on the way out.
Most OpenAPI documents in the wild are YAML. Until this release, bringing one into the editor meant converting it to JSON on the way in — which worked, but handed you back a file your repository did not recognise as the same document.
The editor now reads and writes both. The syntax a document arrived in is recorded with it, and everything downstream honours it.
What this changes
- Import accepts YAML as readily as JSON, including multi-document files and anchors.
- The Source tab and the Modify Source drawer show the document in the format you work in, switchable from one place.
- Snapshots and export produce YAML for a YAML document, so a diff against your repository is a diff of your changes rather than of the serialiser.
Picking a format on export
Format is a preference, not a property of the document: pick JSON or YAML on export and the choice sticks across every screen that hands you raw source. Where converting would lose something — a comment, an anchor, a key order that carried meaning — the export notice says so before you download.
If you keep your spec in YAML and gave up on visual editing because of the format churn, this is the release to try again.