Skip to main content

Module about

Module about 

Source
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

ColumnKindDescription
haystackVersionStrHaystack specification version (e.g. "4.0")
serverNameStrServer implementation name
serverVersionStrServer software version
productNameStrProduct name
productUriUriProduct homepage URI
moduleNameStrModule / crate name
moduleVersionStrModule / crate version

§Errors

  • 401 Unauthorized — missing or invalid Authorization header.
  • 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).