From b00af27de59ddc7dcd118964e579168411d1d2d2 Mon Sep 17 00:00:00 2001
From: meeki007 <5952964+meeki007@users.noreply.github.com>
Date: Thu, 27 Jul 2023 21:12:54 -0400
Subject: [PATCH] Update 02-rest-api.mdx - note about URL Encoding (#22221)

Explanation on proper URL Encoding for parameters.
BAD: ?tz=Etc/GMT+10
GOOD: ?tz=Etc%2FGMT%2B10
---
 docs/en/14-reference/02-rest-api/02-rest-api.mdx | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/docs/en/14-reference/02-rest-api/02-rest-api.mdx b/docs/en/14-reference/02-rest-api/02-rest-api.mdx
index ea010f42db..4da987213c 100644
--- a/docs/en/14-reference/02-rest-api/02-rest-api.mdx
+++ b/docs/en/14-reference/02-rest-api/02-rest-api.mdx
@@ -79,6 +79,12 @@ Parameter Description:
 - tz: Optional parameter that specifies the timezone of the returned time, following the IANA Time Zone rules, e.g. `America/New_York`.
 - req_id: Optional parameter that specifies the request id for tracing.
 
+:::note
+
+URL Encoding. Make sure that parameters are properly encoded. For example, when specifying a timezone you must properly encode special characters. ?tz=Etc/GMT+10 will not work because the <+> plus symbol is recognized as a space in the url. It's best practice to encode all special characters in a parameter. Instead use ?tz=Etc%2FGMT%2B10 for the parameter.
+
+:::
+
 For example, `http://h1.taos.com:6041/rest/sql/test` is a URL to `h1.taos.com:6041` and sets the default database name to `test`.
 
 TDengine supports both Basic authentication and custom authentication mechanisms, and subsequent versions will provide a standard secure digital signature mechanism for authentication.