Expand description
The about op — server identity and SCRAM authentication handshake.
§Overview
GET /api/about is dual-purpose:
- Unauthenticated (HELLO / SCRAM): drives the three-phase SCRAM SHA-256 handshake (HELLO → server challenge, SCRAM → client proof verification, BEARER → authenticated access).
- Authenticated (BEARER token): returns the server about grid.
POST /api/close revokes the bearer token (logout).
§Request
No request grid is required. Authentication state is conveyed via the
Authorization header (HELLO, SCRAM, or BEARER scheme).
§Response Grid Columns
| Column | Kind | Description |
|---|---|---|
haystackVersion | Str | Haystack specification version (e.g. "4.0") |
serverName | Str | Server implementation name |
serverVersion | Str | Server software version |
productName | Str | Product name |
productUri | Uri | Product homepage URI |
moduleName | Str | Module / crate name |
moduleVersion | Str | Module / crate version |
§Errors
- 401 Unauthorized — missing or invalid
Authorizationheader. - 403 Forbidden — HELLO lookup failed or SCRAM proof verification failed.
- 500 Internal Server Error — grid encoding failure.
Functions§
- handle
- GET /api/about
- handle_
close - POST /api/close — revoke the bearer token (logout).