apache/apisix

docs: update example in serverless Plugin documentation

Open

#8.980 aberto em 1 de mar. de 2023

Ver no GitHub
 (3 comments) (0 reactions) (0 assignees)Lua (16.597 stars) (2.860 forks)batch import
docgood first issue

Description

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"
            ]
        }

Guia do colaborador

Pilha de tecnologia
None
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
basic Lua knowledgefamiliarity with APISIX serverless plugin
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70
Direção de pesquisa
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.