Skip to content
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

Issue 389 publish sensor data api documentation #390

Merged
merged 99 commits into from Mar 22, 2022

Conversation

Flix6x
Copy link
Contributor

@Flix6x Flix6x commented Mar 8, 2022

closes #389
closes #387

Flix6x added 30 commits March 7, 2022 15:28
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
…, besides for CLI scripts

Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
…rough post_load decorators in a specific sequence

Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
…s at once

Signed-off-by: F.N. Claessen <felix@seita.nl>
…p mentioning separate endpoints for postMeterData and postPrognosis

Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
…these fields instead of ignoring them

Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
… more tricky, because the 'id' fields was being passed to the function twice somehow; use_kwargs instead of use_args was needed to avoid this

Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x Flix6x requested a review from nhoening March 18, 2022 22:48
@Flix6x Flix6x added documentation Improvements or additions to documentation API labels Mar 18, 2022
@Flix6x Flix6x added this to In progress in Update API endpoints for time series communication via automation Mar 18, 2022
Copy link
Contributor

@nhoening nhoening left a comment

Choose a reason for hiding this comment

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

Great work - I approve of this, with just two or three small items, which might require a change or an answer.

flexmeasures/api/v3_0/users.py Outdated Show resolved Hide resolved
flexmeasures/api/v3_0/users.py Show resolved Hide resolved
documentation/api/introduction.rst Outdated Show resolved Hide resolved
Update API endpoints for time series communication automation moved this from In progress to Review in progress Mar 19, 2022
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x Flix6x requested a review from nhoening March 22, 2022 08:40
Copy link
Contributor

@nhoening nhoening left a comment

Choose a reason for hiding this comment

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

Approved with one small caveat.

@@ -179,27 +136,26 @@ Throughout this document, keys are written in singular if a single value is list

The API, however, does not distinguish between singular and plural key notation.

Connections and entity addresses
Sensors and entity addresses
Copy link
Contributor

Choose a reason for hiding this comment

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

This gives the impression that this is something you have to know to use the API. But at this point, you don't have to know it. I suggest giving a bit more information about the context in which this info might be useful.

All in all, the whole "Notation" section in this API introduction could use a helicopter perspective on how to put the content into perspective, but that is maybe another PR.

Update API endpoints for time series communication automation moved this from Review in progress to Reviewer approved Mar 22, 2022
@Flix6x Flix6x merged commit 5a3e592 into main Mar 22, 2022
Update API endpoints for time series communication automation moved this from Reviewer approved to Done Mar 22, 2022
@Flix6x Flix6x deleted the Issue-389_Publish_SensorDataAPI_documentation branch March 22, 2022 10:25
@Flix6x Flix6x added this to the 0.9.0 milestone Mar 30, 2022
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
No open projects
Development

Successfully merging this pull request may close these issues.

Publish SensorDataAPI documentation GET /sensorData
3 participants