Apply suggestions from code review

Co-authored-by: Honza Dvorsky <[email protected]>

Author: gayathrisairam

Sources/OpenAPIRuntime/Interface/ErrorHandlingMiddleware.swift

@@ -20,6 +20,7 @@ import HTTPTypes
 /// Errors not conforming to ``HTTPResponseConvertible`` are converted to a response with the 500 status code.
 ///
 /// ## Example usage
+///
 /// 1. Create an error type that conforms to the ``HTTPResponseConvertible`` protocol:
 ///
 /// ```swift
@@ -35,28 +36,19 @@ import HTTPTypes
 /// }
 /// ```
 ///
-/// 2. Opt in to the ``ErrorHandlingMiddleware``  while registering the handler:
+/// 2. Opt into the ``ErrorHandlingMiddleware``  while registering the handler:
 ///
 /// ```swift
 /// let handler = RequestHandler()
 /// try handler.registerHandlers(on: transport, middlewares: [ErrorHandlingMiddleware()])
 /// ```
-/// - Note: The placement of ``ErrorHandlingMiddleware`` in the middleware chain is important.
-/// It should be determined based on the specific needs of each application.
-/// Consider the order of execution and dependencies between middlewares.
+/// - Note: The placement of ``ErrorHandlingMiddleware`` in the middleware chain is important. It should be determined based on the specific needs of each application. Consider the order of execution and dependencies between middlewares.
 public struct ErrorHandlingMiddleware: ServerMiddleware {
 
-    /// Creates an ErrorHandlingMiddleware.
+    /// Creates a new middleware.
     public init() {}
 
-    /// Intercepts an outgoing HTTP request and an incoming HTTP Response, and converts errors(if any) that confirms to ``HTTPResponseConvertible`` to an HTTP response.
-    /// - Parameters:
-    ///   - request: The HTTP request created during the operation.
-    ///   - body: The HTTP request body created during the operation.
-    ///   - metadata: Request metadata
-    ///   - operationID: The OpenAPI operation identifier.
-    ///   - next: A closure that calls the next middleware, or the transport.
-    /// - Returns: An HTTPResponse and an optional HTTPBody.
+    // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
     public func intercept(
         _ request: HTTPTypes.HTTPRequest,
         body: OpenAPIRuntime.HTTPBody?,
@@ -78,21 +70,29 @@ public struct ErrorHandlingMiddleware: ServerMiddleware {
     }
 }
 
-/// A protocol used by ``ErrorHandlingMiddleware`` to map an error to an ``HTTPResponse`` and ``HTTPBody``.
-/// Adopters who wish to convert their application error to an `HTTPResponse` and ``HTTPBody`` should conform the error type to this protocol.
+/// A value that can be converted to an HTTP response and body.
+///
+/// Conform your error type to this protocol to convert it to an `HTTPResponse` and ``HTTPBody``.
+///
+/// Used by ``ErrorHandlingMiddleware``.
 public protocol HTTPResponseConvertible {
 
     /// An HTTP status to return in the response.
     var httpStatus: HTTPResponse.Status { get }
-    /// The HTTP headers of the response.
+
+    /// The HTTP header fields of the response.
     /// This is optional as default values are provided in the extension.
     var httpHeaderFields: HTTPTypes.HTTPFields { get }
+
     /// The body of the HTTP response.
     var httpBody: OpenAPIRuntime.HTTPBody? { get }
 }
 
-/// Extension to HTTPResponseConvertible to provide default values for certain fields.
 extension HTTPResponseConvertible {
+
+    // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
     public var httpHeaderFields: HTTPTypes.HTTPFields { [:] }
+
+    // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
     public var httpBody: OpenAPIRuntime.HTTPBody? { nil }
 }

Tests/OpenAPIRuntimeTests/Interface/Test_ErrorHandlingMiddleware.swift

@@ -32,7 +32,8 @@ final class Test_ErrorHandlingMiddlewareTests: XCTestCase {
         )
         XCTAssertEqual(response.0.status, .ok)
     }
-    func testError_confirmingToProtocol_convertedToResponse() async throws {
+
+    func testError_conformingToProtocol_convertedToResponse() async throws {
         let (response, responseBody) = try await Test_ErrorHandlingMiddlewareTests.errorHandlingMiddleware.intercept(
             Test_ErrorHandlingMiddlewareTests.mockRequest,
             body: Test_ErrorHandlingMiddlewareTests.mockBody,
@@ -45,7 +46,7 @@ final class Test_ErrorHandlingMiddlewareTests: XCTestCase {
         XCTAssertEqual(responseBody, TEST_HTTP_BODY)
     }
 
-    func testError_confirmingToProtocolWithoutAllValues_convertedToResponse() async throws {
+    func testError_conformingToProtocolWithoutAllValues_convertedToResponse() async throws {
         let (response, responseBody) = try await Test_ErrorHandlingMiddlewareTests.errorHandlingMiddleware.intercept(
             Test_ErrorHandlingMiddlewareTests.mockRequest,
             body: Test_ErrorHandlingMiddlewareTests.mockBody,
@@ -57,7 +58,8 @@ final class Test_ErrorHandlingMiddlewareTests: XCTestCase {
         XCTAssertEqual(response.headerFields, [:])
         XCTAssertEqual(responseBody, nil)
     }
-    func testError_notConfirmingToProtocol_returns500() async throws {
+
+    func testError_notConformingToProtocol_returns500() async throws {
         let (response, responseBody) = try await Test_ErrorHandlingMiddlewareTests.errorHandlingMiddleware.intercept(
             Test_ErrorHandlingMiddlewareTests.mockRequest,
             body: Test_ErrorHandlingMiddlewareTests.mockBody,
@@ -69,6 +71,7 @@ final class Test_ErrorHandlingMiddlewareTests: XCTestCase {
         XCTAssertEqual(response.headerFields, [:])
         XCTAssertEqual(responseBody, nil)
     }
+
     private func getNextMiddleware(failurePhase: MockErrorMiddleware_Next.FailurePhase) -> @Sendable (
         HTTPTypes.HTTPRequest, OpenAPIRuntime.HTTPBody?, OpenAPIRuntime.ServerRequestMetadata
     ) async throws -> (HTTPTypes.HTTPResponse, OpenAPIRuntime.HTTPBody?) {