README.md

OpenAPI Mode

Minor mode for OpenAPI & Swagger yaml files. Provides support jumping to definitions & references using xref. Navigation helpers to narrow to block and move across yaml blocks.

Keybindings

Standard xref keybindings for jump to definition M-., jump back M-, & show references M-? are used.

Feature	Keybinding	OpenAPI	Swagger
Move forward yaml block	C-M-f	✅	✅
Move backward yaml block	C-M-b	✅	✅
Copy yaml block	C-c C-w	✅	✅
Cut yaml block	C-c C-k	✅	✅
Select/highlight yaml block	C-c C-SPC	✅	✅
Narrow to yaml block	C-x n b	✅	✅
Jump to path operation	C-c C-p	✅	✅
Jump to section	C-c C-s	✅	⬜
Insert component/definition ref	C-c C-c	✅	✅
Insert parameter ref	C-c i p	✅	⬜
Insert header ref	C-c i p	✅	⬜
Insert response ref	C-c i r	✅	⬜
Insert request body ref	C-c i b	✅	⬜
Insert schema ref	C-c i s	✅	⬜

NOTE: Moving back a block moves to the last yaml block moved forward