API reference¶
The whole public API is one header,
include/pain001/client.hpp,
in namespace pain001. Doxygen renders it from the header's comments:
| Type | Role |
|---|---|
Client |
One server; the typed methods and request() |
ClientOptions, RetryPolicy |
Base URL, API key, timeout, opt-in retries |
HealthResponse, ValidationResponse, GenerateResponse, CheckResponse, FaceInfo, FaceResponse, LossReport, Response |
What the methods return |
RowError, CheckFinding, ValidationError |
Items inside the responses and errors |
Error, ApiError, GenerationRefused, TransportError, NoDocument |
What the methods throw (ADR 0003) |
Transport, HttpRequest, HttpResponse, make_curl_transport() |
The HTTP seam, for another stack or a test double |
message_type::k... |
The message types the server knows at this version |
The reference is generated by make docs (Doxygen, then MkDocs) and
built with warnings as errors, so an undocumented public member fails
the build.