Better documentation

Author: emasab

CONFIGURATION.md

@@ -121,7 +121,7 @@ sasl.oauthbearer.assertion.claim.jti.include |  *  | true, false     |         f
 sasl.oauthbearer.assertion.claim.nbf.seconds |  *  | 0 .. 2147483647 |            60 | low        | Assertion not before time in seconds. Only used when `sasl.oauthbearer.method` is set to "oidc" and JWT assertion is needed. <br>*Type: integer*
 sasl.oauthbearer.assertion.claim.sub     |  *  |                 |               | low        | JWT subject claim. Only used when `sasl.oauthbearer.method` is set to "oidc" and JWT assertion is needed. <br>*Type: string*
 sasl.oauthbearer.assertion.jwt.template.file |  *  |                 |               | low        | Path to the JWT template file. Only used when `sasl.oauthbearer.method` is set to "oidc" and JWT assertion is needed. <br>*Type: string*
-sasl.oauthbearer.metadata.authentication.type |  *  | none, azure_imds |          none | low        | Type of metadata based authentication to use for OAUTHBEARER/OIDC `azure_imds` authenticates using the Azure IMDS endpoint. Sets a default value for `sasl.oauthbearer.token.endpoint.url` if missing. Configuration values specific of chosen authentication type can be passed through `sasl.oauthbearer.config`. <br>*Type: enum value*
+sasl.oauthbearer.metadata.authentication.type |  *  | none, azure_imds |          none | low        | Type of metadata-based authentication to use for OAUTHBEARER/OIDC `azure_imds` authenticates using the Azure IMDS endpoint. Sets a default value for `sasl.oauthbearer.token.endpoint.url` if missing. Configuration values specific of chosen authentication type can be passed through `sasl.oauthbearer.config`. <br>*Type: enum value*
 plugin.library.paths                     |  *  |                 |               | low        | List of plugin libraries to load (; separated). The library search path is platform dependent (see dlopen(3) for Unix and LoadLibrary() for Windows). If no filename extension is specified the platform-specific extension (such as .dll or .so) will be appended automatically. <br>*Type: string*
 interceptors                             |  *  |                 |               | low        | Interceptors added through rd_kafka_conf_interceptor_add_..() and any configuration handled by interceptors. <br>*Type: see dedicated API*
 group.id                                 |  C  |                 |               | high       | Client group id string. All clients sharing the same group.id belong to the same group. <br>*Type: string*

src/rdhttp.c

@@ -276,6 +276,8 @@ static void rd_http_ssl_configure(rd_kafka_t *rk, CURL *hreq_curl) {
  *          otherwise return rd_false.
  *
  * @locality Any thread.
+ * @locks None.
+ * @locks_acquired None.
  */
 static rd_bool_t rd_http_is_failure_temporary(int error_code) {
         switch (error_code) {

src/rdkafka_conf.c

@@ -1213,7 +1213,7 @@ static const struct rd_kafka_property rd_kafka_properties[] = {
         "sasl.oauthbearer.metadata.authentication.type",
         _RK_C_S2I,
         _RK(sasl.oauthbearer.metadata_authentication.type),
-        "Type of metadata based authentication to use for OAUTHBEARER/OIDC "
+        "Type of metadata-based authentication to use for OAUTHBEARER/OIDC "
         "`azure_imds` authenticates using the Azure IMDS endpoint. "
         "Sets a default value for `sasl.oauthbearer.token.endpoint.url` if "
         "missing. "

tests/0126-oauthbearer_oidc.c

@@ -467,6 +467,7 @@ static rd_kafka_conf_t *oidc_configuration_metadata_authentication(
         return conf;
 }
 
+/* Test metadata-based authentication cases against Trivup. */
 void do_test_produce_consumer_with_OIDC_metadata_authentication(
     rd_kafka_conf_t *conf) {
         rd_kafka_conf_t *metadata_authentication_conf;