chore: update comment

aws-amplify · Sep 25, 2023 · 44a4c50 · 44a4c50
1 parent f2bd107
commit 44a4c50
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/packages/smithy/smithy_aws/lib/src/http/interceptors/with_sig_v4.dart b/packages/smithy/smithy_aws/lib/src/http/interceptors/with_sig_v4.dart
@@ -32,6 +32,10 @@ class WithSigV4 extends HttpRequestInterceptor {
   @override
   Future<AWSBaseHttpRequest> intercept(AWSBaseHttpRequest request) async {
     // Do not attempt to sign requests where auth is optional.
+    //
+    // This is only set in Cognito and SSO services where the trait indicates
+    // that signing is strictly unnecessary and that signing the request does
+    // not impact the behavior of the APIs.
     if (isOptional) return request;
 
     final signer = AWSSigV4Signer(