Merge pull request #21 from tkausch/security-README-and-project-cleanup

Updating DocC and used swift version to generate the docs

Author: tkausch

.github/workflows/deploy-docc.yml

@@ -30,7 +30,7 @@ jobs:
       - name: Setup Xcode
         uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: '15.4'
+          xcode-version: '16.1'
 
       - name: Build DocC
         run: |

Sources/SwiftRestRequests/Documentation.docc/Articles/Configuration.md

@@ -119,15 +119,11 @@ let combined = RestOptions.combine(baseOptions, authOptions, customOptions)
 ## Topics
 
 ### Configuration
-- ``RestOptions/headers``
+- ``RestOptions/httpHeaders``
 - ``RestOptions/queryParameters``
-- ``RestOptions/timeoutInterval``
+- ``RestOptions/requestTimeoutSeconds``
 - ``RestOptions/expectedStatusCodes``
-- ``RestOptions/acceptedMimeTypes``
-
-### Security
-- ``RestOptions/serverPinning``
-- ``RestOptions/tlsConfiguration``
+- ``RestOptions/dateDecodingStrategy``
 
 ### Related Types
 - ``RestApiCaller``

Sources/SwiftRestRequests/Documentation.docc/Articles/GettingStarted.md

@@ -1,9 +1,5 @@
 # Getting Started
 
-@Metadata {
-    @Title("Getting Started")
-}
-
 Follow these steps to integrate ``SwiftRestRequests`` into a Swift Package or Xcode project and perform your
 first request.
 

Sources/SwiftRestRequests/Documentation.docc/Articles/Interceptors.md

@@ -121,8 +121,7 @@ class ThreadSafeInterceptor: RequestInterceptor {
 - ``AuthorizerInterceptor``
 
 ### Protocols
-- ``RequestInterceptor``
-- ``ResponseInterceptor``
+- ``URLRequestInterceptor``
 
 ### Related Types
 - ``RestApiCaller``

Sources/SwiftRestRequests/Documentation.docc/SwiftRestRequests.md

@@ -32,7 +32,7 @@ The package supports iOS, macOS, watchOS, tvOS, visionOS, and Linux. It targets
 
 - ``URLRequestAuthorizer``
 - ``BasicRequestAuthorizer``
-- ``BearerReqeustAuthorizer``
+- ``BearerRequestAuthorizer``
 - ``NoneAuthorizer``
 - ``AuthorizerInterceptor``
 

Sources/SwiftRestRequests/RestError.swift

@@ -41,16 +41,16 @@ import FoundationNetworking
 /// ## Topics
 ///
 /// ### Response Validation Errors
-/// - ``badResponse(_:_:)``
-/// - ``invalidMimeType(_:)``
-/// - ``unexpectedHttpStatusCode(_:)``
+/// - ``badResponse(response:data:)``
+/// - ``invalidMimeType(mimeType:)``
+/// - ``unexpectedHttpStatusCode(statusCode:)``
 ///
 /// ### Data Processing Errors
-/// - ``malformedResponse(_:_:_:)``
+/// - ``malformedResponse(response:data:underlying:)``
 /// - ``invalidQueryParameter``
 ///
 /// ### API Errors
-/// - ``failedRestCall(_:_:error:)``
+/// - ``failedRestCall(response:status:errorPayload:)``
 ///
 /// ## Usage Example
 /// ```swift