Version
StableGenerated from capsule-server/openapi.json, the OpenAPI 3.2 document
capsule-server emits and mise run openapi-check-kynos keeps current. To change a
description on this page, change the annotation on the handler or model it comes from
and regenerate — this file is build output. The auth model, error contract, and
conventions common to every endpoint are on the REST API overview.
GET /v1/version
Section titled “GET /v1/version”Reports the server’s name and version.
Unauthenticated and side-effect free. Clients use it as a reachability probe before attempting a protocol handshake, so it must stay cheap and must never fail for a reason the caller could act on — there is no failure variant, and the return type says so.
Authentication: none.
| Status | Body | Description |
|---|---|---|
200 | VersionResponse application/json | OK. |
413 | — | the request body exceeds the configured limit. |
Schemas
Section titled “Schemas”The models these endpoints carry. A field whose type names another model links to it when this page documents that model, which it does when some path from an operation reaches it within 4 references. A model only ever reached deeper than that is named without being expanded.
VersionResponse
Section titled “VersionResponse”Identifies the running server.
Deliberately incurious: a name and a version, no build host, no commit, no uptime, no
feature list. This endpoint is unauthenticated, so everything it returns is public, and a
key-free server has no reason to hand an anonymous caller a fingerprint of its deployment.
Exact client build identification runs the other way (S-D15) — clients tell the server
what they are, not the reverse.
| Field | Type | Description |
|---|---|---|
name | string | Required. The server package name. |
version | string | Required. The server package version. |