[WAF] Document Application Profiles and Schema Profile workflow - #32573
Open
danielegm wants to merge 3 commits into
Open
[WAF] Document Application Profiles and Schema Profile workflow#32573danielegm wants to merge 3 commits into
danielegm wants to merge 3 commits into
Conversation
github-actions
Bot
assigned
abdelrahman-t,
alexpovel,
djhworld,
elithrar,
janrueth,
mattrighetti,
xmflsct,
davejbax and
zrkn
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
Contributor
danielegm
marked this pull request as ready for review
August 7, 2026 15:25
danielegm
requested review from
a team,
abdelrahman-t,
alexpovel,
davejbax,
djhworld,
elithrar,
janrueth,
mattrighetti,
xmflsct and
zrkn
as code owners
August 7, 2026 15:25
Contributor
Review
👉 Fix in your agent 👈Fix the following review findings in PR #32573 (https://github.com/cloudflare/cloudflare-docs/pull/32573).
Before making changes, review each finding and present a brief summary table:
- For each finding, state whether you agree, disagree, or need clarification
- If you disagree (e.g. the fix requires disproportionate effort for minimal benefit,
or the finding is factually incorrect), explain why
- If you need clarification before deciding, ask those questions
- Then share your plan for which issues to tackle and in what order
After triaging, follow this order:
1. Post a comment on this PR for any findings you are skipping, with the finding ID and your reasoning.
2. Then commit the fixes for the legitimate findings.
The comment must come before the commit — the bot reads PR comments when a new
push triggers a review, so skip comments posted after the push will be missed.
---
## Code Review
### Suggestions (2)
#### CR-0e8fed966a81 · Maintain consistent ordering in data files
- **File:** `src/content/fields/index.yaml` line 518
- **Issue:** The new `cf.schema_validation.learned.violated` and `cf.schema_validation.uploaded.violated` entries are inserted between `cf.api_gateway.request_violates_schema` and `cf.api_gateway.fallthrough_detected` in the head file. If entries are ordered alphabetically, the `cf.api_gateway.*` block should remain contiguous.
- **Fix:** Verify the intended sort order. If alphabetical, move the `cf.schema_validation.*` entries to their correct position after all `cf.api_gateway.*` entries.
#### CR-bf03ff625aeb · Clear and concise field summaries
- **File:** `src/content/fields/index.yaml` line 522
- **Issue:** The summary says "Returns `true` when an evaluated request [violates the learned profile]...". The phrase "an evaluated request" is awkward.
- **Fix:** Rephrase to "Returns `true` when a request [violates the learned profile]..." or "Indicates whether a request [violates the learned profile]..." to match the style of other `cf.*` boolean fields.
---
## Conventions
### Warnings (2)
#### CV-4f9d1dc4ed27 · Description explains the work
- **File:** PR-level finding
- **Issue:** The PR description contains only the unmodified pull request template with an empty Summary section and no human-written explanation of the changes.
- **Fix:** Add a brief human-written summary explaining what the PR updates, such as the new Application Profiles and Schema Profiles documentation pages and any related edits to existing API Shield and WAF content.
#### CV-e42ad63a77eb · Scope accuracy
- **File:** PR-level finding
- **Issue:** The PR adds six new MDX pages under waf/detections/application-profiles, rewrites material in multiple api-shield/schema-validation pages, and touches waf/index.mdx and src/content/fields/index.yaml, none of which are mentioned in the description.
- **Fix:** Update the description to mention the core changes: new Application Profiles documentation, the new Schema Profiles workflow, and the associated updates to API Shield/WAF pages and fields metadata.
---
## Style Guide Review
### Warnings (1)
#### SG-9ff5493e1e37 · Internal links must use a trailing slash
- **File:** `src/content/docs/waf/detections/application-profiles/get-started.mdx` line 37
- **Issue:** Link uses `/security/web-assets/manage-operations/#add-operations-manually` without a trailing slash before the anchor.
- **Fix:** Change the link to `/security/web-assets/manage-operations/#add-operations-manually`.
### Suggestions (1)
#### SG-27b9ba7eb4e7 · Bullet list has fewer than three items
- **File:** `src/content/docs/waf/detections/application-profiles/index.mdx` line 47
- **Issue:** Line 47 starts a bulleted list with only two items (lines 47-48).
- **Fix:** Consider writing the two "See also" links as prose instead of a bullet list.
Code ReviewThis code review is in beta and may not always be helpful — use your judgment. Suggestions (2)
ConventionsWarnings (2)
Style Guide ReviewWarnings (1)
Suggestions (1)
CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
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
10 participants
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.
Summary
Screenshots (optional)
Documentation checklist