Issue 58 api documentation lists each endpoint twice #59
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Flix6x
approved these changes
Mar 10, 2021
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.
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.
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.
I'd reserve the "Data" quickref for time series data only. "Assets" fits better here.
nhoening
deleted the
issue-58-API_documentation_lists_each_endpoint_twice
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #58