apache/apisix

docs: update example in serverless Plugin documentation

Open

#8 980 ouverte le 1 mars 2023

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)Lua (2 860 forks)batch import
docgood first issue

Métriques du dépôt

Stars
 (16 597 stars)
Métriques de merge PR
 (Merge moyen 6j 8h) (109 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Le ticket demande de mettre à jour l'exemple de documentation du plugin serverless dans la documentation d'Apache APISIX (https://apisix.apache.org/docs/apisix/plugins/serverless/#enabling the plugin). L'exemple actuel est une simple fonction de journalisation ; remplacez le par un exemple plus complet utilisant l'API core.request.get uri args comme fourni dans le corps du ticket. Assurez vous que l'exemple est du Lua syntaxiquement correct et correspond au style de la documentation.
Stack technique
lua
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80