Skip to content

Rest API: use externalDocs #847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Maschga
Copy link
Contributor

@Maschga Maschga commented Jul 14, 2025

Fix #844

@Maschga
Copy link
Contributor Author

Maschga commented Jul 14, 2025

In some descriptions, there are multiple Markdown urls.
See /state, for instance:

docs/static/rest-api.yaml

Lines 759 to 763 in 966aba1

description: >
Returns the complete state of the system. This structure is used by the
UI. It can be filtered by [JQ](https://jqlang.github.io/jq/) to only
return a subset of the data. [Read
more.](https://docs.evcc.io/en/docs/reference/configuration/state)

However, externalDocs only allows one url to be provided:
OAI/OpenAPI-Specification#1034

Perhaps we should only make this change once the feature is available.

\cc @andig

@Maschga Maschga changed the title Reat API: use externalDocs Rest API: use externalDocs Jul 14, 2025
@andig
Copy link
Member

andig commented Jul 14, 2025

We could use it where already possible?

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.

OpenAPI: investigate simplifying description
2 participants