This API's OpenAPI document
This document as built into the binary; the API reference at `/api/docs` (Scalar, bundled, outside `/api/v1`) reads it from here. Works without credentials. The `ETag` is the quoted SHA-256 of the document; send it back in `If-None-Match` to get `304` while the server still implements the same document.
openapi/harthelm.yaml at v1.5.0If-None-Match?stringThe ETag of a copy the caller already has; while it is current the answer is 304 without a body.
The document.
response?stringapplication/yamlcurl -X GET 'https://console.example.com/api/v1/openapi.yaml'"openapi: 3.1.0\ninfo:\n title: Harthelm API\n version: 0.8.0\npaths: {}\n"The JSON Schema of harthelm.yml
`schemas/harthelm.schema.json` (draft 2020-12, schema `harthelm/v1`), served from the binary so editors and code-server's YAML extension never fetch it from the internet. Works without credentials.
The server's version
Works without credentials. `hart` compares `api_version` with the version it was generated from and warns about a skew; every API response also carries the header `Harthelm-Version: <version>`.