Skip to content

[Enh]: Improve health endpoint with filters #3278

@JerryNixon

Description

@JerryNixon

What

Make the health endpoint easier to use.

Introduce tag filters

Support filtering health checks by tag using query parameters.

https://localhost:5000/health?tag=rest
https://localhost:5000/health?tag=graphql
https://localhost:5000/health?tag=mcp
https://localhost:5000/health?tag=endpoint
https://localhost:5000/health?tag=data-source

Support compound filters by specifying multiple tags.

https://localhost:5000/health?tag=rest&tag=graphql

Introduce easy aliases

Provide simple aliases for common filters so they are easy to demo and remember.

https://localhost:5000/health/rest
https://localhost:5000/health/graphql
https://localhost:5000/health/mcp
https://localhost:5000/health/data-source

These routes internally translate to the equivalent tag filter.

/health/rest        -> /health?tag=rest
/health/graphql     -> /health?tag=graphql
/health/mcp         -> /health?tag=mcp
/health/data-source -> /health?tag=data-source

Introduce UI

Introduce a path that consumes the health report and renders it as a web page.

https://localhost:5000/health/ui

A similar feature is already present in our extension: https://marketplace.visualstudio.com/items?itemName=jerry-nixon.health-data-api-builder

Note

This feature will shine. A valuable part of our Aspire story. An important link to emit with dab start.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions