Apply doc. suggestions from code review

jharley · brandonc · web-flow · commit 3526b7bd08dc · 2024-08-02T13:07:00.000-04:00
Co-authored-by: Brandon Croft &lt;brandon.croft@gmail.com&gt;
diff --git a/errors.go b/errors.go
@@ -50,8 +50,9 @@ type ErrorObject struct {
 }
 
 // ErrorSource is an object containing references to the primary source of the error.
+// Only one field should be populated depending on the source of the error.
 type ErrorSource struct {
-	// Pointer is a string indicating the value in the request document that caused the error.
+	// Pointer is a JSON Pointer (RFC6901) indicating the value in the request document that caused the error.
 	Pointer string `json:"pointer,omitempty"`
 
 	// Parameter is a string indicating which query or path parameter caused the error.

Original file line number	Diff line number	Diff line change
`@@ -50,8 +50,9 @@ type ErrorObject struct {`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`// ErrorSource is an object containing references to the primary source of the error.`
	`53`	`+// Only one field should be populated depending on the source of the error.`
`53`	`54`	`type ErrorSource struct {`
`54`		`- // Pointer is a string indicating the value in the request document that caused the error.`
	`55`	`+ // Pointer is a JSON Pointer (RFC6901) indicating the value in the request document that caused the error.`
`55`	`56`	Pointer string `json:"pointer,omitempty"`
`56`	`57`
`57`	`58`	`// Parameter is a string indicating which query or path parameter caused the error.`