Skip to content

Add API State reference page - #1145

Merged
naltatis merged 1 commit into
mainfrom
feat/api-state-reference
Aug 7, 2026
Merged

Add API State reference page#1145
naltatis merged 1 commit into
mainfrom
feat/api-state-reference

Conversation

@naltatis

@naltatis naltatis commented Aug 6, 2026

Copy link
Copy Markdown
Member

Adds a dedicated reference page for the /api/state data structure at /en/reference/state (and /de/…), generated at build time from the bundled OpenAPI spec.

Builds on the generated state schema introduced in evcc-io/evcc#32431.
Replaces #746
Pairs with evcc-io/evcc#32568

  • 📄 Long flat page: root fields under Top Level, referenced schemas as sections under Types, everything alphabetical
  • 🔗 Anchor per type and per field, $ref types link to their section, reverse Used by links per type
  • 📡 Intro explains the three transports: REST (with demo and jq examples), MQTT topic mapping, websocket incremental updates
  • 🔍 Fully static, indexed by Starlight search
  • 📦 public/openapi.yaml refreshed from the main repo (nightly state; will be replaced by the next release sync)
  • ↪️ MQTT API pages now link to the new page
Bildschirmfoto 2026-08-06 um 12 52 42 Bildschirmfoto 2026-08-06 um 12 52 22 Bildschirmfoto 2026-08-06 um 12 52 30

Renders the /api/state schema from the bundled OpenAPI spec as a flat,
searchable reference page with anchors and reverse links.
Refreshes public/openapi.yaml from the main repo (nightly, until next release).
@naltatis

naltatis commented Aug 6, 2026

Copy link
Copy Markdown
Member Author

\cc @Maschga

@naltatis naltatis mentioned this pull request Aug 6, 2026
6 tasks
@naltatis
naltatis merged commit 85a7f67 into main Aug 7, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant