update interceptor doc comment

aws-amplify · Sep 12, 2023 · 6ac9c0c · 6ac9c0c
1 parent a6e0df8
commit 6ac9c0c
Showing 1 changed file with 8 additions and 5 deletions.
diff --git a/AmplifyPlugins/API/Sources/AWSAPIPlugin/Configuration/AWSAPIEndpointInterceptors.swift b/AmplifyPlugins/API/Sources/AWSAPIPlugin/Configuration/AWSAPIEndpointInterceptors.swift
@@ -9,18 +9,21 @@ import Amplify
 import Foundation
 import AWSPluginsCore
 
+/// The order of interceptor decoration is as follows:
+/// 1. **prelude interceptors**
+/// 2. **cutomize headers**
+/// 3. **customer interceptors**
+/// 4. **postlude interceptors**
+///
+/// **Prelude** and **postlude** interceptors are used by library maintainers to
+/// integrate essential functionality for a variety of authentication types.
 struct AWSAPIEndpointInterceptors {
     // API name
     let apiEndpointName: APIEndpointName
 
     let apiAuthProviderFactory: APIAuthProviderFactory
     let authService: AWSAuthServiceBehavior?
 
-    /// The order of interceptor decoration is as follows:
-    /// 1. **prelude interceptors**: append default auth info
-    /// 2. **cutomize headers**: headers provided when constructing the request
-    /// 3. **customer interceptors**: customer defined interceptors
-    /// 4. **postlude interceptors**: calculate checksums, signatures
     var preludeInterceptors: [URLRequestInterceptor] = []
 
     var interceptors: [URLRequestInterceptor] = []