Skip to content

docs(server-api): add Swagger UI link and code block language tags #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
julpayne wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(server-api): add Swagger UI link and code block language tags #106

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ccb85e4
docs(server-api): add Swagger UI link and code block language tags
julpayne Aug 18, 2026
9d92d32
docs(server-api): format Swagger and Redoc UI links with Markdown syntax
julpayne Aug 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions src/content/docs/reference/server-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://eval-hub.github.io/eval-hub/> for the full specification.
See below for the full specification:

- [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

```
```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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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 |
Expand Down
Loading