advancedTLS: Documentation #7213
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #7213 +/- ##
==========================================
- Coverage 81.24% 80.55% -0.69%
==========================================
Files 345 349 +4
Lines 33941 34040 +99
==========================================
- Hits 27574 27421 -153
- Misses 5202 5428 +226
- Partials 1165 1191 +26 |
security/advancedtls/advancedtls.go
Outdated
| // Package advancedtls is a utility library containing functions to construct | ||
| // credentials.TransportCredentials that can perform credential reloading and | ||
| // custom verification check. | ||
| // Package advancedtls is a library containing APIs for configuring grpc |
There was a problem hiding this comment.
Nit: all packages are libraries, and all libraries contain APIs, so I think you could remove some words here to make everything more to-the-point. How about something like:
Package advancedtls provides gRPC transport credentials that allow easy configuration of advanced TLS features.
There was a problem hiding this comment.
Changed, I like that
security/advancedtls/advancedtls.go
Outdated
| @@ -119,8 +124,9 @@ type GetRootCAsResults = RootCertificates | |||
|
|
|||
| // RootCertificateOptions contains options to obtain root trust certificates | |||
| // for both the client and the server. | |||
| // At most one option could be set. If none of them are set, we | |||
| // use the system default trust certificates. | |||
| // At most one option should be set. If none of them are set, we use the system | |||
There was a problem hiding this comment.
What is an "option"? Is each option a single field in this struct? If so, maybe "at most one field should be set"?
There was a problem hiding this comment.
Changed, good call
| @@ -153,18 +159,18 @@ func (o RootCertificateOptions) nonNilFieldCount() int { | |||
|
|
|||
| // IdentityCertificateOptions contains options to obtain identity certificates | |||
| // for both the client and the server. | |||
| // At most one option could be set. | |||
Add documentation to the main package, the
RootCertificateOptionsstruct, and theIdentityCertificateOptionsstruct.RELEASE NOTES: none