# OpenAPI Python client

The broker's REST API has a generated Python client, published on PyPI as
[`jfjoch-client`](https://pypi.org/project/jfjoch-client/) and regenerated from
`broker/jfjoch_api.yaml` by `update_version.sh` — the YAML is the single source of truth
(see [OpenAPI](OPENAPI.md)).

- [Client README](python_client/README.md) — installation, quick start, and the index of every
  endpoint and model.
- [DefaultApi](python_client/docs/DefaultApi.md) — the full endpoint reference, with a generated
  example per call.

The per-model pages are generated as well and are linked from the two pages above. They are built
with the site but kept out of the navigation sidebar on purpose — sixty generated reference pages
would otherwise be most of it.

```{toctree}
:hidden:
:glob:

python_client/README
python_client/docs/*
```