docs(api-shield): surface discovery requirements inline including Workers exclusion#32044
Open
zeinjaber wants to merge 1 commit into
Open
docs(api-shield): surface discovery requirements inline including Workers exclusion#32044zeinjaber wants to merge 1 commit into
zeinjaber wants to merge 1 commit into
Conversation
…kers exclusion Closes DEE-3708
zeinjaber
requested review from
a team,
danielegm,
elithrar and
xmflsct
as code owners
Contributor
Review✅ No issues found in commit Code ReviewThis code review is in beta and may not always be helpful — use your judgment. No code review issues found. ConventionsNo convention issues found. Style Guide ReviewNo style-guide issues found. CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
Contributor
|
Preview URL: https://8cb1dbaa.preview.developers.cloudflare.com Files with changes (up to 15) |
xmflsct
approved these changes
Jul 13, 2026
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
5 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.
What
Expand the Requirements section on the API Shield Discovery page to list the three discovery conditions inline:
Also adds a note that the API Shield subscription must be active at both account and zone level.
Why
TSEs and customers using the Cloudflare traffic simulator or Worker-based test harnesses repeatedly hit the Workers exclusion condition without knowing it exists. The previous Requirements section only linked to the WAM discovery requirements page without surfacing the constraints inline — customers had to follow the link and find the relevant section.
Chat signal: https://chat.google.com/room/AAAAj1kIEx8/U_m7OWjLO-Q (Jul 7–8 2026, API Shield room) — SE reported traffic simulator not discovering endpoints; engineer responded by quoting all three requirements verbatim.
The conditions are already documented on the WAM side (Discovery requirements). This change surfaces them on the API Shield page so customers don't need to follow a cross-product link to understand why their endpoints aren't appearing.
Files changed
src/content/docs/api-shield/security/api-discovery.mdx— Requirements section expanded (+8 lines)How to verify
Read the Requirements section at /api-shield/security/api-discovery/ — three bullet conditions and the dual subscription note should appear before the cross-link to WAM.
Closes DEE-3708