Config schema and OpenAPI files

Machine-readable contracts of the xtandard-image server: the JSON Schema of its config file and the OpenAPI 3.1 document of its HTTP API. They are published at stable URLs on this site.

Files

Document	Versioned (v1)	Latest
Config file JSON Schema (draft 2020-12)	schema/v1/config.schema.json	schema/latest/config.schema.json
OpenAPI 3.1 document	schema/v1/openapi.json	schema/latest/openapi.json

v1 is the schema major version. It is the config schema’s $id and changes only when a key is removed or renamed; latest follows the newest major. A running instance serves the exact copy for its own version on the admin listener: GET /config.schema.json and GET /openapi.json.

API reference

Browse the OpenAPI document with Scalar (loaded from cdn.jsdelivr.net at a pinned version). The OpenAPI document page explains how it is generated and served.

Editor support

YAML (yaml-language-server: VS Code, JetBrains, Neovim, Helix), first line:

# yaml-language-server: $schema=https://xantiagoma.github.io/xtandard-image/schema/v1/config.schema.json

JSON, a top-level key the loader ignores:

{ "$schema": "https://xantiagoma.github.io/xtandard-image/schema/v1/config.schema.json" }

TOML (Taplo, Tombi), first line:

#:schema https://xantiagoma.github.io/xtandard-image/schema/v1/config.schema.json

The schema URLs use xantiagoma.github.io, the config schema’s $id, which GitHub redirects to this site. Every setting is described in Configuration.