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 (2.860 forks)batch import
docgood first issue

Métricas do repositório

Stars
 (16.597 stars)
Métricas de merge de PR
 (Mesclagem média 6d 8h) (109 fundiu PRs em 30d)

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

Direção de pesquisa
A issue solicita a atualização do exemplo da documentação do plugin serverless na documentação do Apache APISIX (https://apisix.apache.org/docs/apisix/plugins/serverless/#enabling the plugin). O exemplo atual é uma função de log simples; substitua o por um exemplo mais abrangente que use a API core.request.get uri args conforme fornecido no corpo da issue. Certifique se de que o exemplo seja Lua sintaticamente correto e se ajuste ao estilo da documentação.
Pilha de tecnologia
lua
Domain
documentation
Tipo Issue
Documentação
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 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80