Ensure SecurityValidator docs all match

Author: gpickin

interfaces/ISecurityValidator.cfc

@@ -10,9 +10,10 @@ interface{
 	 * This function is called once an incoming event matches a security rule.
 	 * You will receive the security rule that matched and an instance of the ColdBox controller.
 	 *
-	 * You must return a struct with two keys:
+	 * You must return a struct with three keys:
 	 * - allow:boolean True, user can continue access, false, invalid access actions will ensue
 	 * - type:string(authentication|authorization) The type of block that ocurred.  Either an authentication or an authorization issue.
+	 * - messages:string Info/debug messages
 	 *
 	 * @return { allow:boolean, type:string(authentication|authorization), messages:string }
 	 */
@@ -22,9 +23,10 @@ interface{
 	 * This function is called once access to a handler/action is detected.
 	 * You will receive the secured annotation value and an instance of the ColdBox Controller
 	 *
-	 * You must return a struct with two keys:
+	 * You must return a struct with three keys:
 	 * - allow:boolean True, user can continue access, false, invalid access actions will ensue
 	 * - type:string(authentication|authorization) The type of block that ocurred.  Either an authentication or an authorization issue.
+	 * - messages:string Info/debug messages
 	 *
 	 * @return { allow:boolean, type:string(authentication|authorization), messages:string }
 	 */

models/validators/CBAuthValidator.cfc

@@ -15,12 +15,12 @@ component singleton {
 	 * You will receive the security rule that matched and an instance of the
 	 * ColdBox controller.
 	 *
-	 * You must return a struct with two keys:
+	 * You must return a struct with three keys:
 	 * - allow:boolean True, user can continue access, false, invalid access actions will ensue
 	 * - type:string(authentication|authorization) The type of block that ocurred.  Either an authentication or an authorization issue.
 	 * - messages:string Info/debug messages
 	 *
-	 * @return { allow:boolean, type:authentication|authorization, messages:string }
+	 * @return { allow:boolean, type:string(authentication|authorization), messages:string }
 	 */
 	struct function ruleValidator( required rule, required controller ){
 		return validateSecurity( arguments.rule.permissions );
@@ -30,12 +30,12 @@ component singleton {
 	 * This function is called once access to a handler/action is detected.
 	 * You will receive the secured annotation value and an instance of the ColdBox Controller
 	 *
-	 * You must return a struct with two keys:
+	 * You must return a struct with three keys:
 	 * - allow:boolean True, user can continue access, false, invalid access actions will ensue
 	 * - type:string(authentication|authorization) The type of block that ocurred.  Either an authentication or an authorization issue.
 	 * - messages:string Info/debug messages
 	 *
-	 * @return { allow:boolean, type:authentication|authorization, messages:string }
+	 * @return { allow:boolean, type:string(authentication|authorization), messages:string }
 	 */
 	struct function annotationValidator( required securedValue, required controller ){
 		return validateSecurity( arguments.securedValue );

models/validators/CFValidator.cfc

@@ -12,12 +12,12 @@ component singleton {
 	 * You will receive the security rule that matched and an instance of the
 	 * ColdBox controller.
 	 *
-	 * You must return a struct with two keys:
+	 * You must return a struct with three keys:
 	 * - allow:boolean True, user can continue access, false, invalid access actions will ensue
 	 * - type:string(authentication|authorization) The type of block that ocurred.  Either an authentication or an authorization issue.
 	 * - messages:string Info/debug messages
 	 *
-	 * @return { allow:boolean, type:authentication|authorization, messages:string }
+	 * @return { allow:boolean, type:string(authentication|authorization), messages:string }
 	 */
 	struct function ruleValidator( required rule, required controller ){
 		return validateSecurity( arguments.rule.roles );
@@ -27,12 +27,12 @@ component singleton {
 	 * This function is called once access to a handler/action is detected.
 	 * You will receive the secured annotation value and an instance of the ColdBox Controller
 	 *
-	 * You must return a struct with two keys:
+	 * You must return a struct with three keys:
 	 * - allow:boolean True, user can continue access, false, invalid access actions will ensue
 	 * - type:string(authentication|authorization) The type of block that ocurred.  Either an authentication or an authorization issue.
 	 * - messages:string Info/debug messages
 	 *
-	 * @return { allow:boolean, type:authentication|authorization, messages:string }
+	 * @return { allow:boolean, type:string(authentication|authorization), messages:string }
 	 */
 	struct function annotationValidator( required securedValue, required controller ){
 		return validateSecurity( arguments.securedValue );