Additional Endpoints for VUI API

[davidraker]

Description

Added:

• Platforms Agents Configs endpoints (configuration store management).

Fixes # (issue)
eclipse-volttron/volttron-lib-web/issues/11
eclipse-volttron/volttron-lib-web/issues/12
eclipse-volttron/volttron-lib-web/issues/13
eclipse-volttron/volttron-lib-web/issues/14
eclipse-volttron/volttron-lib-web/issues/15
eclipse-volttron/volttron-lib-web/issues/35

Type of change

Please delete options that are not relevant.

• New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Unit tests in volttrontesting/platform/web/test_vui_endpoints.py.

Test Configuration:

• Firmware version:
• Hardware:
• Toolchain:
• SDK:

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

[craig8]

The agents end point only returns agents that are currently running on the platform.

http://localhost:8070/vui/platforms/volttron1 ==============================
DEBUG:volttron.web.client.base:============================== GET /vui/platforms/volttron1/agents ==============================
DEBUG:volttron.web.client.base:{'route_options': {'platform.driver': '/vui/platforms/volttron1/agents/platform.driver'}}
DEBUG:volttron.web.client.base:============================== END GET http://localhost:8070/vui/platforms/volttron1/agents ==============================

vctl list
  AGENT                    IDENTITY            TAG                   PRI
a listeneragent-3.3        listeneragent-3.3_1 listener
1 platform_driveragent-4.0 platform.driver     platform_driver
b sqlhistorianagent-4.0.0  platform.historian  platform_historian

[davidraker]

The default value of the sgent-state query parameter is "r unning". To see all installed agents, try:
GET /vui/platforms/volttron1/agents?agent-state=installed

[craig8]

beautiful.

[craig8]

Calling /vui/platforms/{self.name}/agents/{identity} with an identity that doesn't exist, returns a 200 and paths to links that shouldn't exist.

Should we instead do a 404 or 405? response code?

I think you have this as a pattern for config store entries...but this should be a different pattern.

So after the call to /vui/platforms/{self.name}/agents/{identity}

I then make a call to the status link and get a 400 error. So I am thinking the agents should return 400.

[davidraker]

Yeah, if that's true, it's a bug. We need to check if the identity exists, and 404 it. Same should be true if config store entries don't exist, actually. Only POST config should work if the entry doesn't exist.

…

-------- Original message -------- From: Craig ***@***.***> Date: 5/20/22 18:31 (GMT-06:00) To: VOLTTRON/volttron ***@***.***> Cc: "Raker, David M" ***@***.***>, Author ***@***.***> Subject: [EXTERNAL] Re: [VOLTTRON/volttron] Additional Endpoints for VUI API (PR #2948) Calling /vui/platforms/{self.name}/agents/{identity} with an identity that doesn't exist, returns a 200 and paths to links that shouldn't exist. Should we instead do a 404 or 405? response code? I thiink you have this as a pattern for config store entries...but this should be a different pattern. — Reply to this email directly, view it on GitHub<https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgit.luolix.top%2FVOLTTRON%2Fvolttron%2Fpull%2F2948%23issuecomment-1133463179&data=05%7C01%7CDavid.Raker%40rockets.utoledo.edu%7C9b820907aa944b72a45a08da3ab8e574%7C1d6b1707baa94a3da8f8deabfb3d467b%7C0%7C0%7C637886863043864752%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=6LYmzdWcYPkjUM%2BHXARieBrwq2V94d5jOhoYaQtYe50%3D&reserved=0>, or unsubscribe<https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgit.luolix.top%2Fnotifications%2Funsubscribe-auth%2FAGXWOADFIDVJZVUXQV2LVB3VLAOF5ANCNFSM5SQXY6SQ&data=05%7C01%7CDavid.Raker%40rockets.utoledo.edu%7C9b820907aa944b72a45a08da3ab8e574%7C1d6b1707baa94a3da8f8deabfb3d467b%7C0%7C0%7C637886863043864752%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=ZEFlJQ4Um6xrlQbhrH8U4OaKVFZ%2BEeoqoPG8FuzWKcQ%3D&reserved=0>. You are receiving this because you authored the thread.Message ID: ***@***.***>

[craig8]

the post with an identity that doesn't exist for config store should be ok as well.