API Genie editor changelog

What changed in each release of the API Genie editor. The desktop editor's installers are on the downloads page, and the web editor opens at api-genie.dev/editor. The RSS feed carries each new release with its notes.

Changelogs: CLI · Editor · Doc components · GitHub Action

0.12.0 (2026-11-08)

  • The right pane has no Code tab. Show as code on a file’s root form, such as the Specification row’s, shows the whole file as wide as the pane. While a file has syntax errors, its forms offer Show the file as code. A file picked in the file list opens its root form. The code no longer follows the tree’s selection, and its cursor no longer selects in the tree.

  • With one spec open, the tree starts with a Specification row that opens the whole spec’s form: its version and its sections. The form is headed Specification, in place of Document.

  • In a schema’s rows, the type menu keeps its width and the description takes the rest. A long component name among the menu’s references made the menu as wide as the name.

  • A long form, such as an operation’s, lists its sections beside it: pick one to go to it, or Overview to go back to the start of the form. The list marks the section you are reading and hides when the form is narrow.

  • AsyncAPI’s forms, such as a message’s, list their sections as well.

  • A schema’s form lists its sections too: the details of the row shown, in groups (Values, Limits, Flags, Composition) now headed in the details panel, and the keys edited as code.

  • Each key a form has no field for, such as externalDocs or a parameter’s style, is a section of its own, named after the key and edited as code, in place of one Other fields section.

  • The forms’ section headings, such as Parameters, Request body, Responses and Messages, are bands with an accent edge, set apart from the fields above them.

  • The parameters table’s In, Required and Schema columns grow with their text in Safari and the macOS app, where a header parameter’s header ran into yes.

  • The code view, Show as code and the text diffs use CodeMirror in place of Monaco: the app’s code is less than half its former size, about 4.5 MB instead of 10 MB. Completion and hover still come from the spec’s structure, and now work while the line you type is not valid YAML yet. The editor’s colours follow the app’s light and dark palettes.

  • YAML is highlighted in the code view and in a form’s Show as code.

  • File › Close Spec (Ctrl+W, Cmd+W on macOS) closes the open spec and the files it brought, asking about unsaved changes first. The editor is then as it starts with no spec.

  • A New spec… button joins the toolbar. With no spec open, it asks for OpenAPI 3.1 or AsyncAPI 3.0, as File › New… does, then where to save the spec. The editor writes the spec there and opens it.

  • File › Open Recent lists the last ten specs opened, then Clear Recent. Started without a spec on the command line, the editor opens the newest one that still exists.

  • Files changed on disk, by a git checkout or another editor, are read again when you come back to the window. A file with unsaved changes keeps them: the status bar names it, and Save writes over the version on disk. A file deleted on disk is named in the status bar.

  • A View menu shows and hides the Side Bar (Ctrl+B), the Panel (Ctrl+J) and the Right Pane (Ctrl+Alt+B); on macOS, Cmd+B, Cmd+J and Cmd+Option+B. With the panel closed, the form and the right pane now reach the status bar.

  • Export bundled works in the desktop app for OpenAPI specs, and the Changes tab shows the API changes there. The installers now carry openapi_bundle, openapi_diff and asyncapi_diff, compiled to WebAssembly.

  • The splitters between the panes are thicker, with a grip in the middle.

  • A path’s template and its path parameters change together in the forms. Each change is one undo step. A change that would give the path another path’s template is refused, and nothing changes.

    • Setting a parameter’s In to path makes it required and adds /{name} at the end of the template.
    • Renaming a path parameter renames its {name}, and the other path parameters of that name in the path and its operations. A name another path parameter already has is refused.
    • Removing a path parameter, or setting its In to another place, takes {name} out of the template (/pets/{id} becomes /pets). It stays when another path parameter of the path or its operations has that name.
    • The path’s form and an operation’s form do all three. A parameter’s own form renames it and sets its In.
    • Editing the template in the path’s form renames, adds or removes path parameters to match. A new {name} gets a required string path parameter on the path. When as many {name}s go as come, they are read as renames, in order.
    • Renaming a path parameter or editing the template leaves the parameters taken by $ref as they are. A rename then keeps their {name}, and a {name} of theirs renamed in the template gets a new path parameter.
    • In the path’s form, a path parameter of the path or its operations that the template lacks has a button, Add {name} to the template, which adds /{name} at the end.
  • The tree lists these sections even when the spec lacks them: Servers, Tags, Paths, Webhooks (3.1 only) and Components in OpenAPI; Servers, Channels, Operations, Messages and Components in AsyncAPI. Each section, and each component section under Components, has a + that adds an entry and selects it, so that its form opens. A section the spec lacks is created with that entry. The + of Components asks which kind of component to add. The right-click menu has the same items, such as Add server, Add operation… and Add schema, and Insert on a focused row does what its + does. Shift+F10 opens that menu on keyboards without Insert.

  • The + of Paths asks for the method and the path of a new operation, and offers the paths the spec has, so that one path can get several operations (GET /pets and POST /pets). A new path is created with its operation. The right-click menu of an operation, and of a path without operations, has Add operation to /pets…, which starts with the path’s first free method, and Insert on such a row opens it too. Adding a method the path already has, or a path of the same shape as one the spec has (/pets/{petId} beside /pets/{id}), says so.

  • The forms of a path item (a path, a webhook, a callback’s path or one under Components) and of an operation have Delete… in their header. It asks first, names the references that would break, deletes as one undo step and opens what held the deleted entry. The right-click menu of an operation under Paths has Delete path /pets… too, since the tree lists a path with operations only through them; for a path that is a $ref, it deletes the path and keeps what the path refers to.

  • The forms of a tag, a server and every component (a schema, response, parameter, example, request body, header, security scheme, link or callback, in AsyncAPI too) have the same Delete…. Deleting a tag leaves the operations that list it as they are, and the confirmation says how many do.

  • A server variable’s Values are chips, as an operation’s tags are: Enter or a comma adds a value, its × removes it.

  • A schema’s Allowed values are chips, as a server variable’s values are. In a numeric or boolean schema a typed 3 or true is added as a number or a boolean, and the values already in the file keep their types. An object or array schema keeps the YAML text field.

  • Values chips no longer leave an empty line under them: the input after the chips takes what is left of their line.

  • Every example box (a schema’s or a property’s example, an Example object’s value, a media type’s and a message’s examples) has a copy button in its top right corner. It copies the example as shown, JSON or YAML.

  • A form’s header shows where its node is, from the file down (openapi.yaml › Paths › /pets › GET › Responses › 200), in place of its JSON pointer, which is now the tooltip. Each step opens that node’s form.

  • The parameters tables of a path and an operation size their columns to what they hold: In, Required and Schema are as narrow as their content, Name takes a fifth of the width and Description the rest.

  • The tree’s sections each have an icon (Info, Servers, Tags, Paths, Webhooks, Components, Channels, Operations, Messages), and so do the spec, shared-file and import-only groups.

  • Example fields show the value as JSON, with a switch to YAML that is kept for the next examples. These are the Example of schemas, parameters and media types, an Example’s Value (formerly Value (YAML)), and a message example’s payload and headers. A value with .inf, .nan or a recursive alias, which JSON can’t hold, stays in YAML. Either is read back, and the file keeps its own style.

  • A schema’s details show its Description, in Markdown with a Write / Preview switch.

  • A schema row’s type menu offers one of, any of and all of, and a reference to each component schema. A schema the menu cannot show (several types, not…) reads complex, and Edit in code opens it in the code view.

  • The Example field of a schema’s details is multi-line, and the other YAML fields there keep the lines of a mapping or a list: a generated object example no longer shows (and saves) as one joined line.

  • An operation’s tags are a multi-select: chips that remove themselves, and an input that adds a tag, suggesting the declared ones.

  • The Problems panel filters by severity (Errors, Warnings, Info, Hints), and keeps the choice.

  • A form shown as code fills the height of the form pane.

  • The file list is headed Spec and referenced files, and the form’s Raw section is split into Other fields and Extensions.

  • The desktop app lints OpenAPI documents with API Genie’s own linter (the rules of apigenie lint), in the Problems tab and under the fields, with its quick fixes: the installers now carry it, compiled to WebAssembly. Until now only the web editor had it.

  • The linters read commands.lint of the project’s apigenie.yaml, and commands.lint.asyncapi for AsyncAPI. The editor takes the file nearest to the spec, as apigenie lint run in the spec’s folder finds it. It looks in the spec’s folder on the desktop and the workspace folder in VS Code; in a browser, among the dropped files. On the desktop and in a browser, Allow access to their folder… widens that to a folder above the spec. Rulesets, severities and custom rules apply in the editor. A configuration the linter refuses is an error on the configuration file in the Problems tab, and then the default rules apply. Custom JavaScript functions don’t run yet: the rules that call them are left out, with a warning. In VS Code an edit to the file applies as you type; elsewhere a change applies when the spec is opened again.

  • The linters read the ruleset files that extends names in apigenie.yaml, and the files those extend (ADR-217): from the spec’s folder on the desktop; in a browser, from a folder allowed with Allow access to their folder…, or in Safari and Firefox among the dropped files when they sit beside apigenie.yaml. Their functions are left out with the rules that call them, and a warning says so. When a ruleset file extends a ruleset the editor’s linter doesn’t have (spectral:oas, owasp, an npm package), that ruleset is left out with a warning. A ruleset file’s aliases and overrides are skipped with a warning too. An extends entry with an absolute path, or a relative path more than 8 folders up, is an error on that entry, and so is a ruleset file that can’t be read or doesn’t parse. The default rules then apply.

  • AsyncAPI documents are linted with API Genie’s AsyncAPI linter (the rules of apigenie lint for AsyncAPI), with its fixes, in every host.

  • The editor no longer runs Spectral’s rulesets (spectral:oas, spectral:asyncapi) or a .spectral.yaml. The Problems tab shows the findings of API Genie’s linters under their own rule names, without Spectral’s second report of the same problems. Spectral rules with no counterpart in API Genie are no longer reported. To keep a .spectral.yaml’s rules, move them to apigenie.yaml: see Migrate from Spectral. A Spectral ruleset (.spectral.yaml, .yml or .json) with no configuration file in the spec’s folder or above it gets an info finding that names that guide.

  • AsyncAPI documents are checked by API Genie alone (ADR-212): the AsyncAPI parser’s findings are gone, and what it checked comes from API Genie’s AsyncAPI linter, which gains 5 rules for the parser’s core checks it lacked (apigenie lint reports them too). A structure error in another file of the spec shows on that file, where the error is.

  • The AsyncAPI docs preview shows API Genie’s own AsyncAPI docs, as apigenie publishes them: the overview, servers and security of the spec, or the operation, channel or message selected in the tree or the code view. It no longer loads the official AsyncAPI renderer, and the editor carries no React.

  • The editor opens specs, not folders (ADR-197). Open folder… is gone: Open spec… (File › Open Spec…, Ctrl+O, on the desktop) opens a spec with the files it refers to. The desktop app starts on a spec given on its command line (apigenie-editor openapi.yaml), dropped spec files open in the browser, and a dropped folder is refused. A new file never overwrites a file on disk the editor did not read: suggested names skip it, and Save refuses and says why.

  • Open spec… opens one spec and the files its references reach, read as references name them, also after an edit adds one (ADR-197). Files that can’t be read are listed under the file list, with Allow access to their folder… on the desktop and in Chromium browsers. In VS Code, the document is the spec and only the files it reaches join it.

  • The opened spec is the file being edited (ADR-197). The other files are referenced: shown in the tree, the file list (under Referenced), the code view and Problems, but read-only, with Edit this file to change one.

  • Path parameters have no Required checkbox: they are always required, and moving a parameter into the path sets required: true with the change.

  • Schema findings on examples, bindings and Try it name the field as code reads it ([0].owner: Unexpected property 'age') instead of a JSON pointer and Ajv’s message.

  • The editor fits its window: in a short window the bottom panel gives way, and the page never scrolls.

  • A tag’s form lists the operations that have the tag, each a link to its form.

  • My schemas in the Library are editable: Edit opens one in the schema editor and the code view, and every change is kept in the library at once, with nothing to save.

  • The Flow tab shows only while the current file is an AsyncAPI spec.

  • A panel under the form and the right pane, as in VS Code, with a Problems tab: every finding of the folder by file, with its rule and line, a filter, and a click that goes to the node. The status bar’s error and warning counts show and hide it, and its height is resizable. The tree and the file list no longer show problem counts.

  • The theme switch in the toolbar is one icon button that steps through the system’s palette, light and dark.

  • The app icon is the website’s favicon, the genie over the word API, in the desktop shell and as the web editor’s favicon.

  • Restyled forms: sections with headings, short fields side by side, Write and Preview tabs opening into the description’s bordered text box, quiet add and remove buttons, aligned table rows, tags and servers as pill toggles, and the operation’s method badge. The schema editor draws guide lines from each schema to its properties and branches, and its Details panel puts paired keywords side by side.

  • Splitters between the panes: drag the borders between the side bar, the form and the right pane, and between the outline, the files and the Library, to resize them. Arrow keys move a focused splitter, a double-click or Enter puts its pane back to the default size, and the sizes are kept for the next visit.

  • A menu bar: File (New…, Open Folder…, Open File…, Save, Save As…, Exit) and Edit (Undo, Redo), with their shortcuts; on macOS, About and Quit are in the application menu and Edit has Cut, Copy, Paste and Select All. New… starts an OpenAPI 3.1 or AsyncAPI 3.0 spec in the open folder; Open File… opens the file’s folder with the file selected; Save As… writes the current file anywhere on disk.

  • Closing the window, quitting, or opening another folder with unsaved files asks whether to save them first.

  • The web editor at https://api-genie.dev/editor/, deployed with the website: the same bundle as the desktop shell’s, with the repository’s WebAssembly modules. The status bar and About show the commit the editor was built from.

  • About, in the toolbar: the editor’s version, the app’s, and where to read what each host offers (the website’s “The editor’s hosts” page).

  • The app opens a folder given on its command line (apigenie-editor <folder>).

  • The desktop shell: the editor in its own window on macOS, Windows and Linux, opening folders in the native dialog and saving to them in place.

  • Try it for AsyncAPI operations: publish a message, with its payload and headers checked against the message’s schemas first, or subscribe and watch what arrives, on the operation’s Kafka, AMQP, MQTT or WebSocket servers. Needs Node.js 20 or later on the machine.

  • A mock server for OpenAPI specs, started from the toolbar: apigenie-server serves the spec as it is in the editor, saved or not, on this computer, and answers and validates requests as it does on the command line. Try it out in the preview can send to it, and its log shows each request and what didn’t match the spec. Needs API Genie 0.11.0 or later installed (npm install -g @mykulyak/api-genie or brew install mykulyak/apigenie/apigenie), or APIGENIE_SERVER set to the apigenie-server binary.

Was this helpful?