From 468cb0c36bbf826317b38ce23f9d76d44d681593 Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Wed, 10 Oct 2018 16:46:34 +0200 Subject: [PATCH] Rename info (#750) * Rename version to info * fix security --- API.md | 3 ++- hassio/api/__init__.py | 14 +++++++------- hassio/api/{version.py => info.py} | 8 ++++---- hassio/api/security.py | 2 +- 4 files changed, 14 insertions(+), 13 deletions(-) rename hassio/api/{version.py => info.py} (80%) diff --git a/API.md b/API.md index d6a6ba4d2..ad8fc4129 100644 --- a/API.md +++ b/API.md @@ -663,12 +663,13 @@ return: ### Misc -- GET `/version` +- GET `/info` ```json { "supervisor": "version", "homeassistant": "version", "hassos": "null|version", + "hostname": "name", "machine": "type", "arch": "arch", "channel": "stable|beta|dev" diff --git a/hassio/api/__init__.py b/hassio/api/__init__.py index 4f86a58ac..cccc1b203 100644 --- a/hassio/api/__init__.py +++ b/hassio/api/__init__.py @@ -10,11 +10,11 @@ from .homeassistant import APIHomeAssistant from .hardware import APIHardware from .host import APIHost from .hassos import APIHassOS +from .info import APIInfo from .proxy import APIProxy from .supervisor import APISupervisor from .snapshots import APISnapshots from .services import APIServices -from .version import APIVersion from .security import SecurityMiddleware from ..coresys import CoreSysAttributes @@ -48,7 +48,7 @@ class RestAPI(CoreSysAttributes): self._register_snapshots() self._register_discovery() self._register_services() - self._register_version() + self._register_info() def _register_host(self): """Register hostcontrol functions.""" @@ -92,13 +92,13 @@ class RestAPI(CoreSysAttributes): web.get('/hardware/audio', api_hardware.audio), ]) - def _register_version(self): - """Register version functions.""" - api_version = APIVersion() - api_version.coresys = self.coresys + def _register_info(self): + """Register info functions.""" + api_info = APIInfo() + api_info.coresys = self.coresys self.webapp.add_routes([ - web.get('/version', api_version.info), + web.get('/info', api_info.info), ]) def _register_supervisor(self): diff --git a/hassio/api/version.py b/hassio/api/info.py similarity index 80% rename from hassio/api/version.py rename to hassio/api/info.py index c18bc6627..ce29efb04 100644 --- a/hassio/api/version.py +++ b/hassio/api/info.py @@ -1,4 +1,4 @@ -"""Init file for Hass.io version RESTful API.""" +"""Init file for Hass.io info RESTful API.""" import logging from .utils import api_process @@ -10,12 +10,12 @@ from ..coresys import CoreSysAttributes _LOGGER = logging.getLogger(__name__) -class APIVersion(CoreSysAttributes): - """Handle RESTful API for version functions.""" +class APIInfo(CoreSysAttributes): + """Handle RESTful API for info functions.""" @api_process async def info(self, request): - """Show version info.""" + """Show system info.""" return { ATTR_SUPERVISOR: self.sys_supervisor.version, ATTR_HOMEASSISTANT: self.sys_homeassistant.version, diff --git a/hassio/api/security.py b/hassio/api/security.py index c0239e05d..d87ee5cb8 100644 --- a/hassio/api/security.py +++ b/hassio/api/security.py @@ -33,7 +33,7 @@ NO_SECURITY_CHECK = re.compile( ADDONS_API_BYPASS = re.compile( r"^(?:" r"|/addons/self/(?!security|update)[^/]+" - r"|/version" + r"|/info" r"|/services.*" r"|/discovery.*" r")$"