Skip to content

Docs/fix various api doc issues#2122

Merged
nhoening merged 8 commits into
mainfrom
docs/fix-various-api-doc-issues
May 21, 2026
Merged

Docs/fix various api doc issues#2122
nhoening merged 8 commits into
mainfrom
docs/fix-various-api-doc-issues

Conversation

@nhoening
Copy link
Copy Markdown
Contributor

@nhoening nhoening commented Apr 19, 2026

Description

Fix a few incorrect issues in documentation (focus: API).

  • add sensor ID to schema in asset's schedule-triggering endpoint
  • add deprecation header and info to schedule-triggering endpoint on sensor
  • state-of-charge field: the sensor needs an instantanious resolution
  • _scheduling_resolution links are broken
  • soc minima in API docs mention a datetime field while the correct ones are start and end?
  • Added changelog item in documentation/changelog.rst

Signed-off-by: Nicolas Höning <nicolas@seita.nl>
…triggering endpoint

Signed-off-by: Nicolas Höning <nicolas@seita.nl>
@read-the-docs-community
Copy link
Copy Markdown

@Flix6x
Copy link
Copy Markdown
Contributor

Flix6x commented Apr 21, 2026

add deprecation header and info to schedule-triggering endpoint on sensor

I would recommend already moving the flexmeasures-client to always use the new endpoint under the hood. I created FlexMeasures/flexmeasures-client#195 accordingly.

nhoening added 2 commits May 20, 2026 16:18
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
nhoening added 3 commits May 20, 2026 16:56
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
…ield

Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
@nhoening nhoening requested a review from Flix6x May 20, 2026 15:18
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
@nhoening nhoening added documentation Improvements or additions to documentation API labels May 20, 2026
Copy link
Copy Markdown
Contributor

@Flix6x Flix6x left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, seems right for this version. In #2190 I started working on making the sensor field more explicitly part of the schema, but moved to implement the consumption and production fields instead.

@nhoening nhoening merged commit 6704b07 into main May 21, 2026
12 checks passed
@nhoening nhoening deleted the docs/fix-various-api-doc-issues branch May 21, 2026 06:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

API documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants