REST API

API Reference

Complete documentation of all public REST API endpoints for the DSS Wiki documentation system.

Documentation API

Endpoints for retrieving documentation content.

GET /api/docs/:slug

Get documentation page content as JSON.

Name	Type	Description
`slug`	string	The page slug (URL-friendly identifier)

{
  "title": "Page Title",
  "description": "Page description",
  "content": "<p>Rendered HTML content...</p>",
  "breadcrumbs": [...]
}

GET /api/export/:slug/docx

Export documentation page as a Microsoft Word document.

Name	Type	Description
`slug`	string	The page slug to export

Returns a .docx file download.

Endpoints for searching documentation.

GET /api/search/autocomplete

Get search suggestions for autocomplete.

Name	Type	Description
`q`	string	Search query string

[
  { "title": "Page Title", "slug": "page-slug", "snippet": "..." },
  ...
]

Endpoints for health checks and monitoring.

GET /health

Full health check with database and service status.

GET /health/live

Liveness probe - returns 200 if the service is running.

GET /health/ready

Readiness probe - returns 200 if the service is ready to accept requests.

GET /metrics

Prometheus-compatible metrics endpoint.