Workspace OpenAPI Editor | Documentation

Location

In each workspace, open OpenAPI Editor from the APIs menu or the path /workspaces/{id}/openapi-editor. A workspace has one linked OpenAPI spec as its main resource.

Editing

Content in YAML or JSON with syntax highlighting in the editor.
Near real-time validation: syntax errors (multiple at once) and OpenAPI rules via the built-in validator.
Preview like Swagger UI in the right panel when the document is valid.

Saving

With "error" severity errors in the validator, saving may be blocked until they are fixed.
In workspaces with multiple collaborators, you must refresh and acquire the lock before editing or saving; in personal or single-user workspaces no lock is required.
Version conflicts (another user saved first) are resolved by reloading or through a merge flow shown in the modal.

Redis (local environments)

The lock and presence features use Redis. If in development you see a service unavailable error, start Redis (e.g. docker compose up redis in the backend).

Import from collection

You can load OpenAPI generated from a collection or paste an imported spec according to the options on the screen.