From 0224aaea7555dfcf2df6ca9e96909e5756d380d7 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: e5b94ba3efd3654a0e232a4c4989b3702f48bd92 Component: cli --- components/cli/docs/extend/authorization.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/components/cli/docs/extend/authorization.md b/components/cli/docs/extend/authorization.md index 23a1787ca3..80fa6c94b1 100644 --- a/components/cli/docs/extend/authorization.md +++ b/components/cli/docs/extend/authorization.md @@ -219,7 +219,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 @@ -247,4 +247,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)