CLOUDP-240738: use digest documentation (#304)

Co-authored-by: Gustavo Bazan <[email protected]>

Author: wtrocki

admin/atlas_client.go

@@ -44,6 +44,9 @@ func NewClient(modifiers ...ClientModifier) (*APIClient, error) {
 // ClientModifiers lets you create function that controls configuration before creating client.
 type ClientModifier func(*Configuration) error
 
+// UseDigestAuth provides Digest authentication for Go SDK.
+// UseDigestAuth is provided as helper to create a default HTTP client that supports HTTP Digest authentication.
+// Warning: any previously set httpClient will be overwritten. To fully customize HttpClient use UseHTTPClient method.
 func UseDigestAuth(apiKey, apiSecret string) ClientModifier {
 	return func(c *Configuration) error {
 		transport := digest.NewTransport(apiKey, apiSecret)
@@ -59,6 +62,12 @@ func UseDigestAuth(apiKey, apiSecret string) ClientModifier {
 // Advanced modifiers.
 
 // UseHTTPClient set custom http client implementation.
+//
+// Warning: UseHTTPClient overrides any previously set httpClient including the one set by UseDigestAuth.
+// To set a custom http client with HTTP diggest support use:
+//
+//	transport := digest.NewTransportWithHTTPRoundTripper(apiKey, apiSecret, yourHttpTransport)
+//	client := UseHTTPClient(transport.Client())
 func UseHTTPClient(client *http.Client) ClientModifier {
 	return func(c *Configuration) error {
 		c.HTTPClient = client

tools/config/go-templates/atlas_client.mustache

@@ -44,6 +44,10 @@ func NewClient(modifiers ...ClientModifier) (*APIClient, error) {
 // ClientModifiers lets you create function that controls configuration before creating client.
 type ClientModifier func(*Configuration) error
 
+
+// UseDigestAuth provides Digest authentication for Go SDK.
+// UseDigestAuth is provided as helper to create a default HTTP client that supports HTTP Digest authentication.
+// Warning: any previously set httpClient will be overwritten. To fully customize HttpClient use UseHTTPClient method.
 func UseDigestAuth(apiKey, apiSecret string) ClientModifier {
 	return func(c *Configuration) error {
 		transport := digest.NewTransport(apiKey, apiSecret)
@@ -58,7 +62,14 @@ func UseDigestAuth(apiKey, apiSecret string) ClientModifier {
 
 // Advanced modifiers.
 
-// UseHTTPClient set custom http client implementation.
+
+//  UseHTTPClient set custom http client implementation.
+//
+//  Warning: UseHTTPClient overrides any previously set httpClient including the one set by UseDigestAuth.
+//  To set a custom http client with HTTP diggest support use: 
+//   
+//   transport := digest.NewTransportWithHTTPRoundTripper(apiKey, apiSecret, yourHttpTransport)
+//   client := UseHTTPClient(transport.Client())
 func UseHTTPClient(client *http.Client) ClientModifier {
 	return func(c *Configuration) error {
 		c.HTTPClient = client