You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
But needs to be completed further. It was agreed that the developers might be a great source of what these various endpoints are for and to initialize this documentation.
This discussion serves for districts and others to talk about pain points in the docs and what should be addressed first.
For example the first PR could only contain a set number of endpoints that are frequently used
I.e.
TimeSeries
Locations
Authorization
...and more below in the comments
@jbkolze thoughts:
Do we have existing cwms documentation (Schema?)
Gate endpoint / schema, don't really know what that is or how it works if the docs say "returns a gate object" that doesn't help
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
@rma-psmorris @MikeNeilson
We discussed briefly in a meeting the topic of creating the dedicated documentation.
It was started here:
https://cwms-data-api.readthedocs.io/latest/
But needs to be completed further. It was agreed that the developers might be a great source of what these various endpoints are for and to initialize this documentation.
This discussion serves for districts and others to talk about pain points in the docs and what should be addressed first.
For example the first PR could only contain a set number of endpoints that are frequently used
I.e.
TimeSeries
Locations
Authorization
...and more below in the comments
@jbkolze thoughts:
Do we have existing cwms documentation (Schema?)
Gate endpoint / schema, don't really know what that is or how it works if the docs say "returns a gate object" that doesn't help
Issue created here per Kolze suggestion above: HydrologicEngineeringCenter/cwms-database#17
@krowvin Thoughts:
We publish the schema docs (java doc like) and publish to that since the API currently is almost a 1:1 with this
@msweier @jbkolze @TroyWeber-SAJ - Others had initial thoughts
Beta Was this translation helpful? Give feedback.
All reactions