Add dedicated article for Limit data export rule - #2136
Draft
claude[bot] wants to merge 1 commit into
Draft
Conversation
Document the Limit data export rule on its own page: the three Full data export modes (Enabled, Disabled, Keep headers), the side effects of limiting export, and the rule creation steps. Register the page in the 6.x and 7.x navigation and llms indexes, add wrappers in both version directories, link it from the Control over Export to Cloud guide and from the Rules WAF overview. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01K14sT9Ka6i82VZQ9dsjLxw
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
wallarm-docs | d901093 | Commit Preview URL Branch Preview URL |
Aug 27 2026, 11:51 AM |
| * The accuracy of Threat Replay Testing | ||
|
|
||
| To exclude only specific parameters identified as containing sensitive data, such as passwords or tokens, use the [**Mask sensitive data**](sensitive-data-rule.md) rule instead - it cuts the values of the specified request points and keeps the rest of the data exported. | ||
|
|
Contributor
There was a problem hiding this comment.
also describe when a customer should use the "Limit data export" rule and when "Mask sensitive data" instead
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by Anastasiia Popova · Slack thread
Before: The Limit data export rule had no page of its own. It was mentioned only as one bullet inside Control over Export to Cloud, among four other export controls. A reader who opened the rule-creation dialog in Wallarm Console and saw the Full data export dropdown had nowhere to look up what its three values do, and the rule was absent from the Rules & Policies navigation where every other rule type is listed.
After: The rule has a dedicated article,
Limiting Data Export, in the Rules & Policies section next to Sensitive Data Masking. It states what the rule controls, lists the three Full data export modes and what the Node exports in each, carries the dialog's own warning that the setting applies to both request and response data, names the visibility that limiting export costs (attack and incident details, API Sessions, security issues, Threat Replay Testing accuracy), points to the Mask sensitive data rule as the narrower alternative for individual sensitive parameters, and gives the creation steps with a screenshot of the dialog. The export-to-cloud guide now links to it from the existing bullet, so the overview stays a summary and the detail lives in one place.How: New page at
docs/latest/user-guides/rules/limit-data-export-rule.md, wrappers indocs/6.x/anddocs/7.x/, nav entries inmkdocs-6.x.ymlandmkdocs-7.x.yml, entries in the fourllms.md/llms.txtindexes, inbound links fromdocs/latest/admin-en/export-to-cloud.mdand the Rules WAF overview, and the screenshot atimages/user-guides/rules/limit-data-export-rule.png(cropped to the dialog form; the help sidebar was dropped because it carried text-selection highlighting). Not added to 5.0 — that version directory is frozen and does not even containexport-to-cloud.md. Nowhat-is-new.mdentry and nosubscription-plans.mdrow: this documents an existing capability rather than shipping a new one.Open items for review
docs/latest/admin-en/export-to-cloud.mdcurrently states that starting from NGINX Node 6.12.4 the rule preserves the request structure and masks only the values, and that metadata-only export is the earlier behavior. The description used for this article (and the in-product help text in the dialog) describes metadata-only as the current Disabled behavior. Both cannot be right. I documented the behavior as described and left that admonition untouched — please confirm which is current so the two pages can be reconciled in this PR.Choose <category> → <rule>(for exampleChange requests/responses → Mask sensitive data). The screenshot does not show which category Limit data export sits under, so the step reads simplyChoose **Limit data export**. Tell me the category and I will match the sibling pattern.Keep headerswording. Documented as "metadata and headers", per Anastasiia's confirmation. Deliberately silent on bodies and query parameters in that mode, since she did not state anything about them.Verification
zensical build -f mkdocs-6.x.yml— clean, "No issues found"; new page renders, image loads, all internal links and anchors resolve.zensical build -f mkdocs-7.x.yml— clean, "No issues found"; page present at/7.x/user-guides/rules/limit-data-export-rule/.scripts/check_markdown_companions.py— 0 missing, both versions (afterscripts/generate_raw_markdown.py).scripts/check_redirects_budget.py— 24 of 100 charged rules, unchanged by this PR (no renames or deletions, so no redirect needed).🤖 Generated with Claude Code
https://claude.ai/code/session_01K14sT9Ka6i82VZQ9dsjLxw
Generated by Claude Code