Fixup broken links in documentation

Author: adam-fowler

SotoCore.docc/SotoCore/AWSClient.md

@@ -78,21 +78,20 @@ The AWSClient requires you shut it down manually before it is deinitialized. The
 
 ### Initializers
 
-- ``init(credentialProvider:retryPolicy:middleware:options:httpClientProvider:logger:)``
-- ``init(credentialProvider:retryPolicy:options:httpClientProvider:logger:)``
-- ``HTTPClientProvider``
+- ``init(credentialProvider:retryPolicy:middleware:options:httpClient:logger:)``
+- ``init(credentialProvider:retryPolicy:options:httpClient:logger:)``
 - ``Options``
 - ``loggingDisabled``
 
 ### Shutdown
 
 - ``shutdown()``
+- ``syncShutdown()``
 
 ### Instance Properties
 
 - ``credentialProvider``
 - ``middleware``
-- ``retryPolicy``
 - ``httpClient``
 
 ### Credentials

SotoCore.docc/SotoCore/SotoCore.md

@@ -21,6 +21,7 @@ SotoCore is the underlying driver for executing requests for the Soto Swift SDK
 
 - ``AWSService``
 - ``AWSServiceConfig``
+- ``AWSServiceErrorType``
 - ``ServiceProtocol``
 - ``Region``
 - ``AWSPartition``
@@ -32,7 +33,6 @@ SotoCore is the underlying driver for executing requests for the Soto Swift SDK
 - ``AWSMiddleware``
 - ``AWSMiddlewareBuilder``
 - ``AWSMiddlewareStack(_:)``
-- ``AWSDynamicMiddlewareStack``
 - ``AWSMiddlewareContext``
 - ``AWSMiddlewareNextHandler``
 - ``AWSEditHeadersMiddleware``
@@ -45,14 +45,14 @@ SotoCore is the underlying driver for executing requests for the Soto Swift SDK
 ### Credentials
 
 - ``CredentialProvider``
-- ``AsyncCredentialProvider``
 - ``NullCredentialProvider``
 - ``ExpiringCredential``
 - ``CredentialProviderFactory``
 - ``DeferredCredentialProvider``
 - ``RotatingCredentialProvider``
 - ``RotatingCredential``
 - ``CredentialProviderError``
+- ``EmptyCredential``
 
 ### Retry
 
@@ -64,7 +64,6 @@ SotoCore is the underlying driver for executing requests for the Soto Swift SDK
 
 - ``AWSEndpoints``
 - ``AWSEndpointStorage``
-- ``AWSEndpointDiscovery``
 
 ### Errors
 
@@ -81,11 +80,10 @@ SotoCore is the underlying driver for executing requests for the Soto Swift SDK
 - ``AWSShape``
 - ``AWSEncodableShape``
 - ``AWSDecodableShape``
-- ``AWSShapeWithPayload``
+- ``AWSErrorShape``
 - ``AWSShapeOptions``
-- ``AWSPayload``
 - ``AWSBase64Data``
-- ``AWSMemberEncoding``
+- ``AWSDocument``
 - ``AWSPaginateToken``
 
 ### Waiters
@@ -98,12 +96,6 @@ SotoCore is the underlying driver for executing requests for the Soto Swift SDK
 - ``JMESAllPathMatcher``
 - ``JMESAnyPathMatcher``
 
-### Streaming
-
-- ``StreamReadFunction``
-- ``StreamReaderResult``
-- ``AWSResponseStream``
-
 ### Encoding/Decoding
 
 - ``QueryEncoder``
@@ -121,6 +113,9 @@ SotoCore is the underlying driver for executing requests for the Soto Swift SDK
 - ``StandardDictionaryCoder``
 - ``StandardArrayCoderProperties``
 - ``StandardDictionaryCoderProperties``
+- ``EC2ArrayCoder``
+- ``EC2StandardArrayCoder``
+- ``DateFormatCoder``
 - ``ISO8601DateCoder``
 - ``HTTPHeaderDateCoder``
 - ``UnixEpochDateCoder``
@@ -142,6 +137,7 @@ SotoCore is the underlying driver for executing requests for the Soto Swift SDK
 
 - ``AWSEventStream``
 - ``AWSEventPayload``
+- ``AWSEventStreamError``
 
 ## See Also
 

Sources/SotoCore/AWSClient.swift

@@ -58,8 +58,8 @@ public final class AWSClient: Sendable {
 
     /// Initialize an AWSClient struct
     /// - parameters:
-    ///     - credentialProvider: An object that returns valid signing credentials for request signing.
-    ///     - retryPolicy: Object returning whether retries should be attempted.
+    ///     - credentialProviderFactory: An object that returns valid signing credentials for request signing.
+    ///     - retryPolicyFactory: Object returning whether retries should be attempted.
     ///         Possible options are `.default`, `.noRetry`, `.exponential` or `.jitter`.
     ///     - middleware: Chain of middlewares to apply to requests and responses
     ///     - options: Configuration flags
@@ -94,8 +94,8 @@ public final class AWSClient: Sendable {
 
     /// Initialize an AWSClient struct
     /// - parameters:
-    ///     - credentialProvider: An object that returns valid signing credentials for request signing.
-    ///     - retryPolicy: Object returning whether retries should be attempted.
+    ///     - credentialProviderFactory: An object that returns valid signing credentials for request signing.
+    ///     - retryPolicyFactory: Object returning whether retries should be attempted.
     ///         Possible options are `.default`, `.noRetry`, `.exponential` or `.jitter`.
     ///     - options: Configuration flags
     ///     - httpClient: HTTPClient to use.
@@ -217,7 +217,7 @@ public final class AWSClient: Sendable {
         let errorLogLevel: Logger.Level
 
         /// Initialize AWSClient.Options
-        /// - Parameters:
+        /// - parameters:
         //    - requestLogLevel: Log level used for request logging
         //    - errorLogLevel: Log level used for error logging
         public init(
@@ -230,10 +230,10 @@ public final class AWSClient: Sendable {
         }
 
         /// Initialize AWSClient.Options
-        /// - Parameters:
-        ///   - signingAlgorithm: Algorithm to use when signing requests
-        //    - requestLogLevel: Log level used for request logging
-        //    - errorLogLevel: Log level used for error logging
+        /// - parameters:
+        ///    - signingAlgorithm: Algorithm to use when signing requests
+        ///    - requestLogLevel: Log level used for request logging
+        ///    - errorLogLevel: Log level used for error logging
         public init(
             signingAlgorithm: AWSSigner.Algorithm,
             requestLogLevel: Logger.Level = .debug,
@@ -476,9 +476,9 @@ extension AWSClient {
 
     /// Generate a signed URL
     /// - parameters:
-    ///     - url : URL to sign
+    ///     - url: URL to sign
     ///     - httpMethod: HTTP method to use (.GET, .PUT, .PUSH etc)
-    ///     - httpHeaders: Headers that are to be used with this URL. Be sure to include these headers when you used the returned URL
+    ///     - headers: Headers that are to be used with this URL. Be sure to include these headers when you used the returned URL
     ///     - expires: How long before the signed URL expires
     ///     - serviceConfig: additional AWS service configuration used to sign the url
     ///     - logger: Logger to output to
@@ -506,7 +506,7 @@ extension AWSClient {
 
     /// Generate signed headers
     /// - parameters:
-    ///     - url : URL to sign
+    ///     - url: URL to sign
     ///     - httpMethod: HTTP method to use (.GET, .PUT, .PUSH etc)
     ///     - headers: Headers that are to be used with this URL.
     ///     - body: Payload to sign as well. While it is unnecessary to provide the body for S3 other services may require it

Sources/SotoCore/AWSService.swift

@@ -24,7 +24,7 @@ public protocol AWSService: Sendable {
     var config: AWSServiceConfig { get }
     /// Create new version of service with patch
     ///
-    /// This is required to support ``with(region:middlewares:timeout:byteBufferAllocator:options:)``.
+    /// This is required to support ``with(region:middleware:timeout:byteBufferAllocator:options:)``.
     /// Standard implementation is as follows
     /// ```swift
     /// public init(from: MyService, patch: AWSServiceConfig.Patch) {
@@ -44,7 +44,7 @@ extension AWSService {
     /// Return new version of Service with edited parameters
     /// - Parameters:
     ///   - region: Server region
-    ///   - middlewares: Additional middleware to add
+    ///   - middleware: Additional middleware to add
     ///   - timeout: Time out value for HTTP requests
     ///   - byteBufferAllocator: byte buffer allocator used throughout AWSClient
     ///   - options: options used by client when processing requests
@@ -70,7 +70,7 @@ extension AWSService {
 
     /// Generate a signed URL
     /// - parameters:
-    ///     - url : URL to sign
+    ///     - url: URL to sign
     ///     - httpMethod: HTTP method to use (.GET, .PUT, .PUSH etc)
     ///     - headers: Headers that are to be used with this URL. Be sure to include these headers when you used the returned URL
     ///     - expires: How long before the signed URL expires
@@ -96,7 +96,7 @@ extension AWSService {
 
     /// Generate signed headers
     /// - parameters:
-    ///     - url : URL to sign
+    ///     - url: URL to sign
     ///     - httpMethod: HTTP method to use (.GET, .PUT, .PUSH etc)
     ///     - headers: Headers that are to be used with this URL. Be sure to include these headers when you used the returned URL
     ///     - body: body payload to sign as well. While it is unnecessary to provide the body for S3 other services require it

Sources/SotoCore/AWSServiceConfig.swift

@@ -56,6 +56,7 @@ public final class AWSServiceConfig {
     ///   - region: Region of server you want to communicate with
     ///   - partition: Amazon endpoint partition. This is ignored if region is set. If no region is set then this is used along side partitionEndpoints to calculate endpoint
     ///   - amzTarget: "x-amz-target" header value
+    ///   - serviceName: Name of service
     ///   - serviceIdentifier: Identifier of service. Used in ARN and endpoint
     ///   - signingName: Name that all AWS requests are signed with
     ///   - serviceProtocol: protocol of service (.json, .xml, .query etc)
@@ -208,7 +209,7 @@ public final class AWSServiceConfig {
     /// Return new version of Service with edited parameters
     /// - Parameters:
     ///   - region: Server region
-    ///   - middlewares: Additional middleware to add
+    ///   - middleware: Additional middleware to add
     ///   - timeout: Time out value for HTTP requests
     ///   - byteBufferAllocator: byte buffer allocator used throughout AWSClient
     ///   - options: options used by client when processing requests

Sources/SotoCore/AWSShapes/Document.swift

@@ -12,7 +12,9 @@
 //
 //===----------------------------------------------------------------------===//
 
-/// Document value that can hold arbitrary data (See https://smithy.io/2.0/spec/simple-types.html#document)
+/// Document value that can hold arbitrary data
+///
+/// (See https://smithy.io/2.0/spec/simple-types.html#document)
 public enum AWSDocument: Sendable, Codable, Equatable {
     case string(String)
     case double(Double)

Sources/SotoSignerV4/signer.swift

@@ -294,6 +294,7 @@ public struct AWSSigner: Sendable {
     ///   - method: http method
     ///   - headers: original headers
     ///   - date: date to use for signing
+    ///   - algorithm: Signing algorithm (sigV4 or sigV4a)
     /// - Returns: Tuple of updated headers and signing data to use in first call to `signChunk`
     public func startSigningChunks(
         url: URL,