You are viewing a plain text version of this content. The canonical link for it is here.

Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2020/11/03 13:39:59 UTC

[GitHub] [apisix] liuxiran commented on a change in pull request #2599: Plugins(Doc): Optimize the document for hmac-auth

liuxiran commented on a change in pull request #2599:
URL: https://github.com/apache/apisix/pull/2599#discussion_r516448923



##########
File path: doc/plugins/hmac-auth.md
##########
@@ -127,7 +128,10 @@ x-custom-header:value
 ### Use the generated signature to try the request
 
 **Note: ACCESS_KEY, SIGNATURE, ALGORITHM, DATE, SIGNED_HEADERS respectively represent the corresponding variables**
-**Note: SIGNED_HEADERS is the headers specified by the client to join the encryption calculation**
+
+**Note: SIGNED_HEADERS is the headers specified by the client to join the encryption calculation. If there are multiple headers, they must be separated by ";": `x-custom-header-a;x-custom-header-b`**
+
+**Note: SIGNATURE needs to use base64 for encryption: `base64_encode(SIGNATURE)`**
 

Review comment:
       it would be better to use one `Note` here.
   e.g :
   Note:
   
   1. xxx
   
   1. xxx




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org