API Reference

On this page

This section documents every API endpoint in the CRAIG system. The pages are generated from the OpenAPI specification embedded in each service, so they always reflect the current implementation.

They are written for non-technical stakeholders (caseworkers, supervisors, and administrators) who want to understand what each service does and what information it accepts and returns.

Regenerating

These pages are generated from source: each service binary supports a --print-openapi flag, so no running devstack is needed. cargo xtask validate fails on any drift between the committed pages and a fresh regeneration (#1022):

cargo xtask api-docs
Edit this page · latest