Documentation
¶
Overview ¶
Package api exposes the Readproof resolution pipeline over HTTP: the wire contract every handler here implements is defined in internal/wire, and shared by internal/client/remote on the client side.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Options ¶
type Options struct {
// APIKey, when non-empty, requires every request except /healthz to
// carry a matching "Authorization: Bearer <APIKey>" header. Empty
// (the default) leaves the API unauthenticated — fine for local
// development, not for exposing readproofd beyond localhost.
APIKey string
}
Options configures the HTTP API.
Source Files
Click to show internal directories.
Click to hide internal directories.