From 7d0507241f1c6ee29d29e01e69f86a7a1432bf7c Mon Sep 17 00:00:00 2001 From: Antonio Murdaca Date: Fri, 18 Dec 2015 11:28:28 +0100 Subject: [PATCH] docs: extend: authorization.md: add a note about confidential stuff in Err Signed-off-by: Antonio Murdaca Upstream-commit: 1e28f04fec70affd8fae57f4bdd23a84853f4efc Component: engine --- components/engine/docs/extend/authorization.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/components/engine/docs/extend/authorization.md b/components/engine/docs/extend/authorization.md index 5330e9d245..f6159baac9 100644 --- a/components/engine/docs/extend/authorization.md +++ b/components/engine/docs/extend/authorization.md @@ -224,7 +224,7 @@ Name | Type | Description --------|--------|---------------------------------------------------------------------------------- Allow | bool | Boolean value indicating whether the request is allowed or denied Msg | string | Authorization message (will be returned to the client in case the access is denied) -Err | string | Error message (will be returned to the client in case the plugin encounter an error) +Err | string | Error message (will be returned to the client in case the plugin encounter an error. The string value supplied may appear in logs, so should not include confidential information) ### Response authorization @@ -252,4 +252,4 @@ Name | Type | Description --------|--------|---------------------------------------------------------------------------------- Allow | bool | Boolean value indicating whether the response is allowed or denied Msg | string | Authorization message (will be returned to the client in case the access is denied) -Err | string | Error message (will be returned to the client in case the plugin encounter an error) +Err | string | Error message (will be returned to the client in case the plugin encounter an error. The string value supplied may appear in logs, so should not include confidential information)