Information
- OpenAPI version:
3.1.0
Overview
Chek server API 0.3.0
Section titled “Chek server API 0.3.0”The contract between the Chek server and its clients. This file is written by hand and is the source of truth: change it in the same pull request as the server code, and clients generate their code from a tagged release.
Every operation except /health, /api/v1/setup and sign-in needs a
session token from sign-in, sent as Authorization: Bearer <token>.
HTTP Basic credentials (name and password) work too, for OPDS reader apps
that can’t hold a token.
Browsers may call the API from the Chek web app’s origins
(CHEK_WEB_ORIGINS, https://app.chek.page by default) and no others.
Admins see every library; readers see only the libraries they were granted,
and other libraries and their publications answer as not found.
Authentication
Section titled “Authentication”session
Section titled “session”The token from sign-in or setup.
Security scheme type: http
A user’s name and password, for apps that can’t sign in first.
Security scheme type: http