[apisix] branch master updated: chore: add some comment for make_request_to_vault function (#8420)

[sp...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

spacewander pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git


The following commit(s) were added to refs/heads/master by this push:
     new 797bc7dbc chore: add some comment for make_request_to_vault function (#8420)
797bc7dbc is described below

commit 797bc7dbcce37eb565bb7a5207534455f90dcf82
Author: soulbird <zh...@outlook.com>
AuthorDate: Fri Dec 2 14:25:41 2022 +0800

    chore: add some comment for make_request_to_vault function (#8420)
    
    Co-authored-by: soulbird <zh...@gmail.com>
---
 apisix/kms/vault.lua | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/apisix/kms/vault.lua b/apisix/kms/vault.lua
index 41111e2b7..aff458f2c 100644
--- a/apisix/kms/vault.lua
+++ b/apisix/kms/vault.lua
@@ -45,7 +45,12 @@ local _M = {
     schema = schema
 }
 
-
+-- This code is copied from apisix/core/vault.lua.
+-- The functions in apisix/core/vault.lua are currently only used in the jwt-auth plugin,
+-- and it is not suitable to be placed in the core module of APISIX.
+--
+-- When KMS is fully functional, we will remove apisix/core/vault.lua.
+--
 local function make_request_to_vault(conf, method, key, data)
     local httpc = http.new()
     -- config timeout or default to 5000 ms