From a2de36a3902e3d82a47e780e0454c996afd29fb7 Mon Sep 17 00:00:00 2001 From: benbenbang Date: Fri, 9 Oct 2026 10:05:13 +0800 Subject: [PATCH] docs(error): clarify MissingCredential covers from_env for any base URL The MissingCredential variant (Rust `ConfigurationErrorKind` and Go `ConfigurationKindMissingCredential`) is also raised by the `from_env` constructors added in #415 when `FMP_API_KEY` is unset or blank, for any base URL including proxies. The previous docs only mentioned direct FMP access, which was misleading. Update the doc comments in both SDKs to describe both cases. --- crates/libfmp/src/error.rs | 4 +++- sdk/go/errors.go | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/crates/libfmp/src/error.rs b/crates/libfmp/src/error.rs index efe7610..3fa1706 100644 --- a/crates/libfmp/src/error.rs +++ b/crates/libfmp/src/error.rs @@ -85,7 +85,9 @@ pub enum ConfigurationErrorKind { InvalidQueryName, /// A credential is empty. EmptyCredential, - /// Direct FMP access was configured without an API credential. + /// No API credential was available: direct FMP access was configured + /// without one, or [`crate::ClientBuilder::from_env`] found + /// `FMP_API_KEY` unset or blank (for any base URL, proxies included). MissingCredential, /// Authentication was configured over plaintext HTTP to a non-loopback host. InsecureAuthentication, diff --git a/sdk/go/errors.go b/sdk/go/errors.go index 11bf27f..9782739 100644 --- a/sdk/go/errors.go +++ b/sdk/go/errors.go @@ -77,7 +77,9 @@ const ( ConfigurationKindInvalidQueryName // ConfigurationKindEmptyCredential: a credential is empty. ConfigurationKindEmptyCredential - // ConfigurationKindMissingCredential: direct FMP access has no credential. + // ConfigurationKindMissingCredential: no credential was available, either + // for direct FMP access or because NewClientFromEnv found FMP_API_KEY + // unset or blank (for any base URL, proxies included). ConfigurationKindMissingCredential // ConfigurationKindInsecureAuthentication: a credential over plain HTTP to a non-loopback host. ConfigurationKindInsecureAuthentication