From 2e1d217eed1cfabf86172e7dae5325a16cf349bd Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Thu, 10 Sep 2020 01:06:32 +0200 Subject: [PATCH] Add current request context to get_url helper documentation (#638) Co-authored-by: Martin Hjelmare --- docs/instance_url.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/instance_url.md b/docs/instance_url.md index c34e6b3a..6dfadaca 100644 --- a/docs/instance_url.md +++ b/docs/instance_url.md @@ -33,6 +33,7 @@ The signature of the helper method: def get_url( hass: HomeAssistant, *, + require_current_request: bool = False, require_ssl: bool = False, require_standard_port: bool = False, allow_internal: bool = True, @@ -46,6 +47,10 @@ def get_url( The different parameters of the method: +- `require_current_request` + Require the returned URL to match the URL the user is currently using + in their browser. If there is no current request, an error will be raised. + - `require_ssl`: Require the returned URL to use the `https` scheme.