Navigation and Search

This page describes the left menu, the top bar, breadcrumbs, favorites and the search field.

The left menu#

The menu shows groups, services, tags, folders, endpoints and text pages.

  • Width. Drag the right edge to resize it. The width (220–560 px) is remembered per user.
  • Collapsed by default. Every page load starts with all groups, services and tags collapsed. Only the nodes that contain the open page are expanded automatically. A node you open or close by hand stays that way until the next page load.
  • Names. Long names are clipped with an ellipsis, and the full text is shown as a tooltip.
  • Icons. Folders, tags and text pages have their own icons. An endpoint shows a colored HTTP-method badge, its title and its URI. An OpenRPC method has no badge. See OpenRPC.
  • Counts. Under each service, three small icons show the number of endpoints, tags and versions, next to a badge with the documentation format (OpenAPI, OpenRPC, AsyncAPI or GraphQL).
  • Structure. The order of folders, tags and endpoints follows the service structure. By default tags are sorted by name and endpoints follow the specification.

Administrators and editors see a Service structure button on a service's row when hovering over it (always visible on touch screens).

Every trail starts with a Services link to the home page. On service, tag and endpoint pages, the branch and version crumbs are dropdowns. See Versions and Branches.

The top bar#

The top bar shows the signed-in user's login and role, the language switcher and the theme selector (light or dark). A Menu dropdown holds the other actions. Each item is shown according to role and session state:

Item Who
Users, Teams, SSO, MCP Server, Notifications, License admin
Create service, Rebuild admin
Orphaned (orphaned overlays) admin, editor
Export Wizard, Profile any signed-in user
Logout any signed-in user (always last)

Features your license does not include (for example MCP, SSO or notifications) are hidden from the menu. The Users and Teams pages update the address bar without a reload, so they can be bookmarked and the browser's Back button works. See License and Tiers.

Favorites#

Signed-in users can star tags, endpoints, folders and text pages. A favorites-only filter narrows the menu to starred items. A favorite is tied to the stable name of the tag or endpoint, so it is the same in every version and branch.

Labels#

Endpoints and text pages can carry labels. A click on a label narrows the menu to items with that label (?label=). See Text Pages.

The search field above the menu searches services, endpoints and text pages on the server.

  • A query must reach search_min_length characters (3 by default) before it is sent.
  • Matching is by substring, not only by prefix, and returns up to 60 results.
  • An endpoint result shows its HTTP method and URI under the title.
  • Text pages are found by title and text, but only in services you can see.
  • Search always covers each service's current version. A personal working version (pin) is not reflected in results.
  • Inside the open service, the menu search also finds items by their manual labels.

Each service page also has a search field above its versions table for the Change Log.

Next steps#

Screenshots

Last updated: