Skip to main content

Workspace

Route/workspace PlanDesigner plandesigner Flag offNEXT_PUBLIC_STUDIO_UNIFIED_WORKSPACE

The workspace is one screen for a version's schemas and paths. It loads only what you select — a domain folder, a search result, a palette action — rather than the whole catalog, and it shows the same model through three lenses. The suite dropdown lists it as Workspace — "Schemas and paths in one domain-scoped workspace".

Rollout

The workspace is staged behind a build-time flag with four stages. At off it is not served; at preview it is reachable from the suite dropdown (with a Preview chip) and the classic canvases show a Try the new workspace banner; at default the Suite home and deep links open it instead of the classic canvas; at only the classic /editor and /paths redirect into it. Your installation's operator sets the stage — see Deploy the studio.

The screen​

RegionWhat it holds
Top barThe brand, the project and version picker, the Domain chip, the Jump to anything… Ctrl / ⌘+K chip, Options, Toggle theme, and the hand-off link — Classic designer ("Open this project on the classic designer canvas."), or Code & exports at the only stage
Left railThe project tree: domain folders, their schemas and paths, and the Tools section
CentreThe lens toolbar, the canvas and the status bar
Right railThe adaptive inspector, 320 pixels wide by default

Domains​

A domain is a folder that scopes the workspace to one part of the version. The Domain chip offers All domains, each folder, and an unassigned bucket for items in no folder; a new version reads "This version has no domain folders yet." Create a folder from the chip (Folder name, for example "Billing"). Move a class or path between folders from its inspector panel.

A folder too large for the canvas budget reads Select items to add to the canvas — pick items from the tree, or Ctrl / ⌘-click the folder to load all of it anyway. The domain travels in the URL (?domain=billing), so a link opens on the same scope and a round trip through the classic canvas returns to it.

The tree​

  • Domain folders, each listing Schemas and its paths with their operations nested beneath.
  • + ("Add a schema to this version") opens an inline form: name, kind, description, domain.
  • + New path… and + New operation… in the Paths and Combined lenses.
  • Select the document root — servers and security schemes are edited there.
  • Tools: Find & replace (find works; the replace half is inert, with a note pointing to the code layer), Property library, Templates… (class templates into the current domain), Import schemas… (the import dialog with an Import into domain picker), Branches (disabled in this build — see Versions, branches and tags), SDK playground, Workspace options….
  • The footer: Export workspace, and Open PR for review and Diff vs published, both disabled behind the same git-like flag.

Lenses​

The lens toolbar switches between Schemas, Paths and Combined, and holds Auto-layout, a zoom button that fits the canvas, Open as code ("Swap the design surface for the developer code layer"), Comments (with the unresolved count), Orphaned, and Mock & preview.

In the Combined lens the canvas draws consumption edges between operations and the schemas they carry: a solid line is a schema used directly in a request or response, a dashed line one nested through a parent class. The legend reads "Combined lens · edges show consumption".

The canvas​

Only the working set is drawn: class cards with six property rows (Show all properties expands them), path and operation lanes, and the consumption edges. Each domain's layout is saved per user, so the arrangement you make is the one you return to. Auto-layout re-arranges the working set.

The ⌘K palette​

Jump to anything… searches the version's schemas and paths by name, in two columns, with bands for Properties, Types and Actions. The footer explains the keys: "Tab switches columns · ↑↓ navigate · ⏎ open · ⇧⏎ list owning classes · esc".

Built-in actions: Find every path that consumes Class, Reveal x on canvas, Switch lens to Combined, Open Class as code, Bind property to type. Two are listed but pending: Add property to class ("the palette cannot open a form prefilled yet — add the property in the rail") and Find every property using type (the type registry has no dependents index yet).

A tenant can add custom actions — hydrate a set, run a consumption query, switch lens, open an https URL — defined through the Apiome REST API; the palette lists them read-only.

The inspector​

The right rail shows a panel for whatever is selected — in the tree, on the canvas or from the palette. Empty: Nothing selected — "Select a class, path, operation, parameter or response — in the tree, on the canvas, or from the ⌘K palette — and it opens here."

SelectionPanel
ClassName, Description (Suggest description), Domain/Folder, Properties, Tags (Add a tag); quick actions Try it, View YAML, Sample JSON, TS interface; Danger → Delete, which lists dependents before deleting. See Schemas
PropertyName, Description, Required, Type (References another class, Type, Format, List of these), the registry type picker, Values (Enum, Min/Max), Advanced…, Suggest properties
PathIts operations; delete
OperationTabs Overview, Request, Responses and Tests (disabled: "Contract testing lands with its own roadmap — this tab opens when it does."); quick actions Try it, View YAML, cURL, SDK snippet. See Paths
Document rootSecurity schemes and Servers

Below the panel: Validation — "This selection" plus Version readiness (Compute; "Not yet computed for this version.") — and a collapsed Reference preview.

Open as code​

Open as code swaps the canvas for the Developer canvas — "Schema editor + Paths editor + SDK playground in one surface": a file tree with openapi.yaml, a dark YAML editor, Problems · live and Lint · live rails, Coding hints (Ctrl / ⌘+S save draft · Shift+Alt+F format · Esc return to canvas), a mini canvas and a diff vs base button. Editing, review and apply work exactly as on Code and exports. The SDK playground notebook is present, but Run is disabled: no sandbox runtime ships with the studio.

Status bar and options​

The status bar names the lens, the selection and a link-count chip. Options opens the view-simplification drawer — "Take chrome away without changing what the workspace shows" — with Hide ⌘K starter chip, Compact tree, Calm status bar, Minimal canvas chrome and Focus mode; the same toggles and the defaults live on Workspace settings.

The AI assistant​

Ctrl / ⌘+Shift+A opens the assistant scoped to the working set — the header says so: "Answering about customers/ — 2 schemas, 4 operations on the canvas". It never sees the whole catalog.