Skip to content

Commit cb83355

Browse files
authored
docs: add JSON <-> YAML conversion instructions to README (#20)
1 parent fbcac1e commit cb83355

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Get full YAML/JSON autocompletion, inline documentation hints, validation, linti
2525
- Semantic Validation & Linting
2626
- Spectral Validation & Linting
2727
- OpenAPI Description dereferencing
28+
- JSON <-> YAML Conversion
2829
- Workspace-Wide Operations
2930

3031
All these commands — and more — are just a keystroke away in VS Code, so you can focus on designing great APIs instead of wrestling with tooling.
@@ -238,6 +239,12 @@ are read directly from your VSCode settings.
238239
![JSON/YAML Formatting](https://github.com/user-attachments/assets/06f21516-7380-4e47-ac77-31a515cd1885)
239240

240241

242+
### JSON <-> YAML Conversion
243+
244+
Right-click inside an OpenAPI document or right-click the file in the Explorer, then choose **OpenAPI Toolkit → Convert to YAML / Convert to JSON** to convert the document from one format to the other and save locally. The default output name is `{filename}.{target-extension}`
245+
246+
![JSON <-> YAML Conversion](https://github.com/user-attachments/assets/50a11c4f-b0c1-4861-8e1f-589389524653)
247+
241248
### Preview
242249

243250
The Preview panel renders the current OpenAPI document and lets you interact with it.

0 commit comments

Comments
 (0)