Browse Source

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.
George Barnett 5 years ago
parent
commit
e461a8487b
2 changed files with 2 additions and 2 deletions
  1. 1 1
      Sources/GRPC/ServerBuilder.swift
  2. 1 1
      Sources/GRPC/TLSConfiguration.swift

+ 1 - 1
Sources/GRPC/ServerBuilder.swift

@@ -111,7 +111,7 @@ extension Server.Builder.Secure {
     return self
   }
 
-  /// Sets whether certificates should be verified. Defaults to `.fullVerification` if not set.
+  /// Sets whether certificates should be verified. Defaults to `.none` if not set.
   @discardableResult
   public func withTLS(certificateVerification: CertificateVerification) -> Self {
     self.tls.certificateVerification = certificateVerification

+ 1 - 1
Sources/GRPC/TLSConfiguration.swift

@@ -160,7 +160,7 @@ extension Server.Configuration {
       }
     }
 
-    /// TLS Configuration with suitable defaults for clients.
+    /// TLS Configuration with suitable defaults for servers.
     ///
     /// This is a wrapper around `NIOSSL.TLSConfiguration` to restrict input to values which comply
     /// with the gRPC protocol.