apache/apisix

docs: update example in serverless Plugin documentation

Open

#8,980 opened on 2023年3月1日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)Lua (16,597 stars) (2,860 forks)batch import
docgood first issue

説明

Current State

The current documentation of the serverless Plugin shows a simple example of a log function:

return function() ngx.log(ngx.ERR, \"serverless pre function\"); end

Desired State

This could be updated with a non-trivial example that could show the capabilities of the Plugin better:

        "serverless-pre-function": {
            "phase": "rewrite",
            "functions" : [
                "return function(conf, ctx)
                    local core = require(\"apisix.core\")
                    if not ngx.var.arg_name then
                        local uri_args = core.request.get_uri_args(ctx)
                        uri_args.name = \"world\"
                        ngx.req.set_uri_args(uri_args)
                    end
                end"
            ]
        }

コントリビューターガイド

技術スタック
なし
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
basic Lua knowledgefamiliarity with APISIX serverless plugin
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70
調査方針
The issue requests updating the serverless plugin documentation example in the Apache APISIX docs (https://apisix.apache.org/docs/apisix/plugins/serverless/#enabling the plugin). The current example is a simple log function; replace it with a more comprehensive example that uses the core.request.get uri args API as provided in the issue body. Ensure the example is syntactically correct Lua and fits the documentation style.
docs: update example in serverless Plugin documentation · apache/apisix#8980 | Good First Issue