20663: Clarify comment about what "safe" config means
authorBrett Smith <brett.smith@curii.com>
Thu, 22 Jun 2023 14:52:05 +0000 (10:52 -0400)
committerBrett Smith <brett.smith@curii.com>
Thu, 22 Jun 2023 15:29:30 +0000 (11:29 -0400)
I might've liked to reveal configuration to authenticated clients, but
not unauthenticated ones. Unfortunately the code doesn't currently
support that.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

lib/config/export.go

index f46f5b6f843542309df4f93b41208853dd285eee..31ccc994b910764c6e98c416b81fe23dca4bfc07 100644 (file)
@@ -37,8 +37,8 @@ func ExportJSON(w io.Writer, cluster *arvados.Cluster) error {
        return json.NewEncoder(w).Encode(m)
 }
 
-// whitelist classifies configs as safe/unsafe to reveal to
-// unauthenticated clients.
+// whitelist classifies configs as safe/unsafe to reveal through the API
+// endpoint. Note that endpoint does not require authentication.
 //
 // Every config entry must either be listed explicitly here along with
 // all of its parent keys (e.g., "API" + "API.RequestTimeout"), or