Skip to content

[Feature Request]: Add API diagram to improve readability of config preview #21862

@yoleichen

Description

@yoleichen

Feature Description

When users click Show Config, we already display a DAB configuration preview before deployment. Add an additional tab called API Diagram that visualizes the generated API surface (REST endpoints, GraphQL operations, MCP tools) derived from the current configuration.

Design Mock:
Image

Functional requirements:

  • A new API Diagram tab is available in Show Config alongside existing config preview.
  • REST section lists the base path and the computed REST endpoints for enabled entities.
  • GraphQL section lists the GraphQL endpoint and available queries/mutations derived from enabled entities/mutations
  • MCP section lists MCP endpoint and shows enabled/disabled tools derived from permissions, plus a scope summary (e.g., “2 entities exposed, operations enabled: Read/Create”).

Problem and Motivation

The DAB config file is powerful but not always easy to interpret quickly, especially for users who want to understand:

  • What endpoints will be created (and their base paths)
  • What GraphQL queries/mutations will be available
  • What MCP tools are enabled/disabled based on exposed entities and permitted operations

A diagram-style view provides a fast “API contract” overview and reduces misconfiguration surprises.

Related Area

  • Connection dialog (SQL Server | Azure browse/Fabric browse)
  • Query editor
  • Query results panel
  • Object Explorer
  • GitHub Copilot integration
  • Preview/Edit data
  • Table Designer
  • Schema Designer
  • Schema Compare
  • Local SQL Server Container provisioning
  • SQL database in Fabric provisioning
  • DACPAC/BACPAC export/import
  • SQL Database projects
  • Query Plan Visualizer
  • Other (please describe below)

If you selected "Other", please describe the area

DAB

Confirmation

  • I have searched existing feature requests and couldn't find a match
  • I want to help implement this feature

Metadata

Metadata

Assignees

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions