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 58 api documentation lists each endpoint twice #59
Issue 58 api documentation lists each endpoint twice #59
Conversation
flexmeasures/api/v1_1/routes.py
Outdated
@@ -271,7 +271,7 @@ def post_weather_data(): | |||
def get_prognosis(): | |||
"""API endpoint to get prognosis. | |||
|
|||
.. :quickref: User; Download prognosis from the platform | |||
.. :quickref: Control; Download prognosis from the platform |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe I don't understand the logic behind your chosen categories, but I think this should be "Data" instead of "Control". Similarly for POSTing prognoses.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I'm on the fence with this one. Not sure if we need those labels for a long time and that it matters much. I'll go with your suggestion.
flexmeasures/api/v1_1/routes.py
Outdated
@@ -62,7 +62,7 @@ | |||
def get_connection(): | |||
"""API endpoint to get the user's connections as entity addresses ordered from newest to oldest. | |||
|
|||
.. :quickref: User; Retrieve entity addresses of connections | |||
.. :quickref: Data; Retrieve entity addresses of connections |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd reserve the "Data" quickref for time series data only. "Assets" fits better here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree.
closes #58