protovalidate: mention error details in docstrings

akshayjshah · akshayjshah · commit 53a6d9ef6c09 · 2024-05-24T22:05:09.000-07:00
Signed-off-by: Akshay Shah &lt;akshay@akshayshah.org&gt;
diff --git a/interceptors/protovalidate/protovalidate.go b/interceptors/protovalidate/protovalidate.go
@@ -15,6 +15,7 @@ import (
 )
 
 // UnaryServerInterceptor returns a new unary server interceptor that validates incoming messages.
+// If the request is invalid, clients may access a structured representation of the validation failure as an error detail.
 func UnaryServerInterceptor(validator *protovalidate.Validator, opts ...Option) grpc.UnaryServerInterceptor {
 	return func(
 		ctx context.Context,
@@ -40,6 +41,7 @@ func UnaryServerInterceptor(validator *protovalidate.Validator, opts ...Option)
 }
 
 // StreamServerInterceptor returns a new streaming server interceptor that validates incoming messages.
+// If the request is invalid, clients may access a structured representation of the validation failure as an error detail.
 func StreamServerInterceptor(validator *protovalidate.Validator, opts ...Option) grpc.StreamServerInterceptor {
 	return func(
 		srv interface{},

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ import (`
`15`	`15`	`)`
`16`	`16`
`17`	`17`	`// UnaryServerInterceptor returns a new unary server interceptor that validates incoming messages.`
	`18`	`+// If the request is invalid, clients may access a structured representation of the validation failure as an error detail.`
`18`	`19`	`func UnaryServerInterceptor(validator *protovalidate.Validator, opts ...Option) grpc.UnaryServerInterceptor {`
`19`	`20`	`return func(`
`20`	`21`	`ctx context.Context,`
`@@ -40,6 +41,7 @@ func UnaryServerInterceptor(validator *protovalidate.Validator, opts ...Option)`
`40`	`41`	`}`
`41`	`42`
`42`	`43`	`// StreamServerInterceptor returns a new streaming server interceptor that validates incoming messages.`
	`44`	`+// If the request is invalid, clients may access a structured representation of the validation failure as an error detail.`
`43`	`45`	`func StreamServerInterceptor(validator *protovalidate.Validator, opts ...Option) grpc.StreamServerInterceptor {`
`44`	`46`	`return func(`
`45`	`47`	`srv interface{},`