REST API

Operator REST API

Interactive API documentation powered by Swagger UI.

The Operator REST API provides endpoints for managing issue types and collections programmatically.

Quick Links

• Base URL: http://localhost:7008/api/v1
• Health Check: GET /api/v1/health
• Status: GET /api/v1/status

Starting the API Server

# Start with default port (7008)
cargo run -- api

# Start with custom port
cargo run -- api --port 8080

Interactive Documentation

Regenerating the Spec

The OpenAPI specification is auto-generated from source code annotations:

# Generate just the OpenAPI spec
cargo run -- docs --only openapi

# Generate all documentation
cargo run -- docs

The spec is written to docs/schemas/openapi.json.