doc: clarify http2.connect authority details

Fixes: #31827 PR-URL: #31828 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Yongsheng Zhang <[email protected]> Signed-off-by: James M Snell <[email protected]>
nodejs · Mar 15, 2020 · dc745e3 · dc745e3
1 parent a2f0930
commit dc745e3
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/doc/api/http2.md b/doc/api/http2.md
@@ -2205,7 +2205,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`.