Cluster Overview
Rich cluster dashboard with description editor, endpoint documentation, response docs, method stats, connected repository, and PDF export.
Overview Dashboard
Select a cluster and click its name (or the OVR tab) to open the Cluster Overview — a rich dashboard for managing your API collection. The overview is a singleton tab (one per cluster).
Header Badges
The overview header displays key metadata as badges:
- Visibility — PUBLIC or PRIVATE
- Sync status — SYNCED or LOCAL
- Request count — Total API requests in the cluster
- Folder count — Number of folders
- Variable count — Defined cluster variables
- Version — Current sync version number
Three Sections
The overview has three tabbed sections:
1. Description
A rich-text editor with a formatting toolbar for documenting your API collection:
- Bold, italic, underline, strikethrough
- Bullet list, numbered list
- Headings (H1, H2, H3, Normal text)
- Links, inline code, horizontal rules
- AI Generate button — AI writes the description based on your cluster structure
A stats sidebar sits alongside the description showing:
- HTTP method distribution — Visual horizontal bar chart (e.g., 12 GET, 5 POST, 3 PUT, 2 DELETE)
- Quick actions — AI Generate, Import File, Export, Add Request, Variables, Authorization, Sync from Cloud
- Owner, members, and role information (for cloud clusters)
2. Documentation
The Documentation section provides:
- Notes — A rich-text editor for team documentation, API guides, and usage notes. Also has an AI Generate button.
- Connected Repository — Link a local project folder to your cluster. VortexHQ uses this to analyze source code (e.g., find controller methods, validation rules, Eloquent casts) for richer auto-generated response docs. Options: Connect from Projects (scans local dev projects), Browse Folder, Change, or Disconnect.
- Endpoint Reference — An auto-generated reference of every request in the cluster, grouped by folder:
Each endpoint in the reference shows:
| Section | Content |
|---|---|
| Method + URL | Color-coded method badge, URL with variable highlighting |
| Parameters | Query params and path params with types |
| Headers | Custom headers with values |
| Body | Example request body (settable via context menu) |
| Auth | Auth type and config |
| Response Docs | AI-generated field documentation with badges (required, optional, nullable, enum, cast, polymorphic, default, rules), success response example, error response example |
Endpoint actions (right-click or kebab menu): Open Request, Re-sync Response Docs, Clear Docs, Set Example Body, Copy as cURL, Copy URL, Copy Response JSON.
Documentation stats bar shows: total requests, documented requests, example count, described count.
Bulk actions: Sync All Response Docs — sequentially generates docs for every endpoint with a progress bar and cancel button. Export Docs as PDF — generates a styled HTML document and exports as PDF via system save dialog.
3. Requests
A flat list view of all requests in the cluster with method badge and folder path — useful for scanning everything at a glance without navigating the folder tree.
Permissions
For cloud clusters with multiple members, the overview respects roles. Viewers see the dashboard in read-only mode — editors and description are disabled.