Update property docs to clarify encoding
@@ -177,9 +177,17 @@ typedef struct az_iot_hub_client_properties
/**
* @brief Initializes the Telemetry or C2D properties.
*
+ * @note The properties init API will not encode properties. In order to support
+ * the following characters:
+ * `/ % # &`
+ * the onus is on the application to properly url encode them (RFC 2396). Only these characters
+ * would have to be encoded. If you would like to avoid the need to encode the names/values,
+ * avoid using these characters in names and values.
+ *
* @param[in] properties The #az_iot_hub_client_properties to initialize
- * @param[in] buffer Can either be an empty #az_span or an #az_span containing properly formatted,
- * RFC 2396-encoded properties with the following format: {key}={value}&{key}={value}.
+ * @param[in] buffer Can either be an empty #az_span or an #az_span containing properly formatted
+ * (with above mentioned characters encoded if applicable) properties with the
+ * following format: {key}={value}&{key}={value}.
* @return #az_result
*/
AZ_NODISCARD az_result
@@ -188,6 +196,13 @@ az_iot_hub_client_properties_init(az_iot_hub_client_properties* properties, az_s
/**
* @brief Appends a key-value property to the list of properties.
*
+ * @note The properties append API will not encode properties. In order to support
+ * the following characters:
+ * `/ % # &`
+ * the onus is on the application to properly url encode them (RFC 2396). Only these characters
+ * would have to be encoded. If you would like to avoid the need to encode the names/values,
+ * avoid using these characters in names and values.
+ *
* @param[in] properties The #az_iot_hub_client_properties to use for this call
* @param[in] name The name of the property.
* @param[in] value The value of the property.
