OpenAPI and schema files

Everything in the reference is generated from files you can download and feed to a client generator, a validator or an agent.

OpenAPI#

Both are OpenAPI 3. In the data API file, row schemas are $refs to the JSON Schema files below, as absolute URLs on this site, so a tool resolves them without extra configuration. The files are served with Access-Control-Allow-Origin: *.

The data API file is kept equal to the service's own router by a contract test: every registered route is in the spec and every operation in the spec is registered, and the query parameters match what each route's parser accepts.

JSON Schemas#

One file per row type at /schemas/{name}.json, for example /schemas/candles.json. They are JSON Schema draft 2020-12. The schema reference lists the fields of each and the file names. The $id inside a schema is the schema's canonical identifier and may name aggre.org; the copy served here is the same file.

Using them#

# validate a row against its schema
curl -s https://docs.aggre.org/schemas/candles.json -o candles.schema.json

# generate a typed client (any OpenAPI 3 generator works)
curl -s https://docs.aggre.org/openapi/data.yaml -o aggre-data.openapi.yaml

Ignore properties a schema does not list: fields are added over time (Versioning).