From ccb85e4cf264c9b0c41d91e23d5bb57115641a05 Mon Sep 17 00:00:00 2001 From: Julian Payne Date: Tue, 18 Aug 2026 14:53:31 +0200 Subject: [PATCH 1/2] docs(server-api): add Swagger UI link and code block language tags Signed-off-by: Julian Payne --- src/content/docs/reference/server-api.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/src/content/docs/reference/server-api.md b/src/content/docs/reference/server-api.md index ee73f5c..9036acd 100644 --- a/src/content/docs/reference/server-api.md +++ b/src/content/docs/reference/server-api.md @@ -8,11 +8,14 @@ Go REST API service for managing LLM evaluation workflows. All endpoints are under `/api/v1`. Request and response bodies use JSON. The OpenAPI 3.1.0 specification is served at `/openapi.yaml`. -See for the full specification. +See below for the full specification: + +- Swagger UI: +- Redoc UI: ### Evaluation Jobs -``` +```text POST /api/v1/evaluations/jobs # Submit evaluation GET /api/v1/evaluations/jobs # List jobs GET /api/v1/evaluations/jobs/{id} # Get job status and results @@ -22,7 +25,7 @@ POST /api/v1/evaluations/jobs/{id}/events # Status/result callback (adapter ### Providers -``` +```text GET /api/v1/evaluations/providers # List providers POST /api/v1/evaluations/providers # Register provider GET /api/v1/evaluations/providers/{id} # Get provider @@ -71,7 +74,7 @@ See [Agent Discoverability](/mcp/agent-discoverability/) for the full metadata m ### Collections -``` +```text GET /api/v1/evaluations/collections # List collections POST /api/v1/evaluations/collections # Create collection GET /api/v1/evaluations/collections/{id} # Get collection @@ -95,7 +98,7 @@ Collection responses may include an optional `agent` object with the same fields ### Health and Metrics -``` +```text GET /api/v1/health # Health check GET /metrics # Prometheus metrics GET /openapi.yaml # OpenAPI specification @@ -109,7 +112,7 @@ Configuration loads from `config/config.yaml`, with environment variable and fil ### Key Settings | Setting | Env Var | Default | Description | -|---------|---------|---------|-------------| +| ------- | ------- | ------- | ----------- | | `service.port` | `PORT` | `8080` | API listen port | | `database.driver` | - | `sqlite` | `sqlite` or `pgx` | | `database.url` | `DB_URL` | SQLite in-memory | Connection string | From 9d92d321942cd79feda0d53f7908ce5d602d4bdc Mon Sep 17 00:00:00 2001 From: Julian Payne Date: Tue, 18 Aug 2026 15:13:58 +0200 Subject: [PATCH 2/2] docs(server-api): format Swagger and Redoc UI links with Markdown syntax Signed-off-by: Julian Payne --- src/content/docs/reference/server-api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/content/docs/reference/server-api.md b/src/content/docs/reference/server-api.md index 9036acd..54e6e81 100644 --- a/src/content/docs/reference/server-api.md +++ b/src/content/docs/reference/server-api.md @@ -10,8 +10,8 @@ All endpoints are under `/api/v1`. Request and response bodies use JSON. The Ope See below for the full specification: -- Swagger UI: -- Redoc UI: +- [Swagger UI](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/eval-hub/eval-hub/refs/heads/main/docs/openapi.yaml) +- [Redoc UI](https://eval-hub.github.io/eval-hub/) ### Evaluation Jobs