Azure / Azure/data-api-builder

[Enh]: Improve health endpoint with filters

Abierto
#3,278 0 comentarios 0 reacciones 0 asignados Ver en GitHub
2.x health-endpoint
Lenguaje dominante
C#
Estrellas
1.5k
Forks
372
Merge medio
3 d 22 h
PR fusionados (30 d)
9

Descripción

## 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`.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza en el punto de entrada del endpoint de health y compara las rutas de query y alias solicitadas con el informe de health existente. Comprueba los ejemplos del issue, incluidos los parámetros de tag repetidos y /health/ui; se considera terminado cuando los filtros y alias devuelven el informe previsto y la UI renderiza ese informe.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
csharp, graphql
Área
api, observability, web-dev
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.