From cbaae7a2f811e57860f560df5cb8fc308f6d70b3 Mon Sep 17 00:00:00 2001
From: James M Snell <jasnell@gmail.com>
Date: Mon, 17 Feb 2020 05:53:31 -0800
Subject: [PATCH] doc: clarify http2.connect authority details

Fixes: https://github.com/nodejs/node/issues/31827

PR-URL: https://github.com/nodejs/node/pull/31828
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com>
Signed-off-by: James M Snell <jasnell@gmail.com>
---
 doc/api/http2.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/doc/api/http2.md b/doc/api/http2.md
index e022b39f044d53..11f41224c4e1d3 100644
--- a/doc/api/http2.md
+++ b/doc/api/http2.md
@@ -2206,7 +2206,11 @@ changes:
                  128 header pairs.
 -->
 
-* `authority` {string|URL}
+* `authority` {string|URL} The remote HTTP/2 server to connect to. This must
+  be in the form of a minimal, valid URL with the `http://` or `https://`
+  prefix, host name, and IP port (if a non-default port is used). Userinfo
+  (user ID and password), path, querystring, and fragment details in the
+  URL will be ignored.
 * `options` {Object}
   * `maxDeflateDynamicTableSize` {number} Sets the maximum dynamic table size
     for deflating header fields. **Default:** `4Kib`.