apache/apisix

docs: update example in serverless Plugin documentation

Open

#8.980 geöffnet am 1. März 2023

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Lua (2.860 Forks)batch import
docgood first issue

Repository-Metriken

Stars
 (16.597 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 6T 8h) (109 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Das Issue fordert die Aktualisierung des Beispiels für das Serverless Plugin in der Apache APISIX Dokumentation (https://apisix.apache.org/docs/apisix/plugins/serverless/#enabling the plugin). Das aktuelle Beispiel ist eine einfache Log Funktion; ersetzen Sie es durch ein umfassenderes Beispiel, das die im Issue Text bereitgestellte core.request.get uri args API verwendet. Stellen Sie sicher, dass das Beispiel syntaktisch korrektes Lua ist und zum Dokumentationsstil passt.
Tech Stack
lua
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80