Skip to content

Commit e461a84

Browse files
authored
Fix incorrect documentation for certificate verification on the server builder (#882)
Motivation: The server build incorrectly claimed that without manually calling `withTLS(certificateVerification:)` that `.fullVerification` would be used. The default is actually `.none`. Modifications: Change the documented default to `.none`. Result: Documentation is no longer incorrect.
1 parent 9744dbc commit e461a84

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

Sources/GRPC/ServerBuilder.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ extension Server.Builder.Secure {
111111
return self
112112
}
113113

114-
/// Sets whether certificates should be verified. Defaults to `.fullVerification` if not set.
114+
/// Sets whether certificates should be verified. Defaults to `.none` if not set.
115115
@discardableResult
116116
public func withTLS(certificateVerification: CertificateVerification) -> Self {
117117
self.tls.certificateVerification = certificateVerification

Sources/GRPC/TLSConfiguration.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ extension Server.Configuration {
160160
}
161161
}
162162

163-
/// TLS Configuration with suitable defaults for clients.
163+
/// TLS Configuration with suitable defaults for servers.
164164
///
165165
/// This is a wrapper around `NIOSSL.TLSConfiguration` to restrict input to values which comply
166166
/// with the gRPC protocol.

0 commit comments

Comments
 (0)