New endpoints for VUI web API #2910
Merged
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
Added enabled endpoints and test to vui_endpoints.
…nto vui_current_state_rebased
…and added endpoint decorator to the method.
Status endpoints
…ning if they had already been stopped.
# Conflicts: # volttrontesting/platform/web/test_vui_endpoints.py
…be more clear and flexible for any future additions.
# Conflicts: # volttron/platform/web/vui_endpoints.py
…ments and unused variables. Removed body of 204 responses.
craig8
reviewed
Mar 5, 2022
| web-ssl-cert = /home/volttron/.volttron/certificates/certs/platform_web-server.crt | ||
| web-ssl-key = /home/volttron/.volttron/certificates/private/platform_web-server.pem | ||
|
|
||
| The ``vctl`` tool may be used to make the changes to the $VOLTTRON_HOME/config file by choosing "Y" for the "Is this |
There was a problem hiding this comment.
Fixed. I make this typo every time to try to use it on the command line too....
|
|
||
| :: | ||
|
|
||
| GET https://localhost:8443/vui/ |
There was a problem hiding this comment.
should be here if we made the bind-web-address to the hostname.
We also need to make sure that hostname is resolvable in order for this to all work the way we want it to.
There was a problem hiding this comment.
Not 100% sure I understand this comment completely, but I've made some changes to the text here to try to address it. Hopefully these address what you were looking for.
| - `Devices <device-endpoints.html>`_ | ||
| - `Historians <historian-endpoints.html>`_ | ||
| - `Pubsub <pubsub-endpoints.html>`_ | ||
| - `Authentication <authentication-endpoints.html>`_: Endpoints for authenticating to the the API. |
There was a problem hiding this comment.
I am pretty sure you should leave off the html and just have the url be the _target in the top of the file. for the docs.
…/admin-endpoints.
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.
Description
Added enabled, running, status, and tag endpoints. Added documentation for these and improved installation documentation, including for setting up the web-users.json file.
Fixes # (issue)
#2862
#2865
eclipse-volttron/volttron-lib-web#2
eclipse-volttron/volttron-lib-web#3
eclipse-volttron/volttron-lib-web#4
eclipse-volttron/volttron-lib-web#5
eclipse-volttron/volttron-lib-web#6
eclipse-volttron/volttron-lib-web#7
eclipse-volttron/volttron-lib-web#18
eclipse-volttron/volttron-lib-web#21
eclipse-volttron/volttron-lib-web#22
eclipse-volttron/volttron-lib-web#23
eclipse-volttron/volttron-lib-web#28
eclipse-volttron/volttron-lib-web#29
eclipse-volttron/volttron-lib-web#30
eclipse-volttron/volttron-lib-web#31
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Tests for all new functionality are included in test_vui_endpoints.py.
Checklist: