add comment about Reason to SchemaError

getkin · Jan 16, 2023 · b137970 · b137970
1 parent eb6dd6d
commit b137970
Showing 1 changed file with 6 additions and 4 deletions.
diff --git a/openapi3/schema.go b/openapi3/schema.go
@@ -1927,10 +1927,12 @@ func (schema *Schema) compilePattern() (err error) {
 }
 
 type SchemaError struct {
-	Value                 interface{}
-	reversePath           []string
-	Schema                *Schema
-	SchemaField           string
+	Value       interface{}
+	reversePath []string
+	Schema      *Schema
+	SchemaField string
+	// Reason is a human-readable message describing the error.
+	// The message should never include the original value to prevent leakage of potentially sensitive inputs in error messages.
 	Reason                string
 	Origin                error
 	customizeMessageError func(err *SchemaError) string