Skip to content

docs: add missing wasm parameters#871

Open
kayx23 wants to merge 2 commits intomasterfrom
docs-add-wasm
Open

docs: add missing wasm parameters#871
kayx23 wants to merge 2 commits intomasterfrom
docs-add-wasm

Conversation

@kayx23
Copy link
Copy Markdown
Member

@kayx23 kayx23 commented Sep 5, 2025

Wasm's priority, file, and http_request_phase were previously documented but got removed in #415 which switched to using helm-docs to generate the docs.

The missed configuration could lead to:

image

This PR adds these parameters back.

@kayx23
Copy link
Copy Markdown
Member Author

kayx23 commented Oct 13, 2025

These parameters are indeed missing from the docs but the updated parameter levels seem wrong.

https://github.com/apache/apisix-helm-chart/blob/master/charts/apisix/templates/configmap.yaml#L297-L301

@kayx23 kayx23 marked this pull request as draft October 13, 2025 09:20
@Baoyuantop Baoyuantop added the enhancement New feature or request label Apr 9, 2026
Comment thread charts/apisix/values.yaml Outdated
# -- Set wasm plugin priority.
priority: 7999
# -- Set path to Wasm plugin.
file: ""
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

priority, file, and http_request_phase are per-plugin properties in APISIX's config, not top-level wasm settings. The existing configmap template just does toYaml .Values.apisix.wasm.plugins, so these top-level values won't be used in the generated config at all.

The correct structure should have these as fields within each plugin entry:

wasm:
  enabled: false
  plugins:
    - name: "example-plugin"
      priority: 7999
      file: "/path/to/plugin.wasm"
      http_request_phase: "rewrite"

As-is, setting apisix.wasm.priority or apisix.wasm.file would have no effect on the rendered config. The docs should show the correct per-plugin structure instead.

@kayx23 kayx23 marked this pull request as ready for review April 27, 2026 07:34
@kayx23 kayx23 requested a review from nic-6443 April 27, 2026 07:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants