@polygonlabs/faucet-api-schemas

Zod response schemas, the OpenAPI registry and the committed openapi.json spec for the Polygon testnet faucet API. They are the single source of truth for the API's wire shapes.

Why this package exists

The faucet API serves its routes through a registry built from these schemas, openapi.json is generated from that registry, and @polygonlabs/faucet-api-client is generated from that spec. Server, spec and client therefore cannot drift apart.

Validating with these exports checks data against the exact schemas the server runs, rather than types re-derived from the OpenAPI document. If you only want a typed client, use @polygonlabs/faucet-api-client, which does this for you.

Install

pnpm add @polygonlabs/faucet-api-schemas

Entry points

• @polygonlabs/faucet-api-schemas: every registered schema, exported under its OpenAPI name (for example InfoResponse, NetworkMetadata, ServiceStatusResponse), plus buildRegistry().
• @polygonlabs/faucet-api-schemas/registry: buildRegistry() on its own.
• @polygonlabs/faucet-api-schemas/openapi.json: the committed OpenAPI document, also served live at /openapi.json, with interactive docs at /docs.

All JSON routes are covered: the core routes (/health-check, /ready, /service-status, /info, /faucetBalances), the auth session routes (/auth/user, /auth/logout) and the transfer routes (/validate, /registerTransferRequest). The session routes need the session cookie, so callers must send credentials. The OAuth login routes (/auth/github, /auth/twitter) are browser redirects and are documented in the spec, not registered.