update API documentation links

[jacobbednarz]

🚨 Don't merge 🚨

Updates all previous documentation links with the new API schema site structure.

[cloudflare-workers-and-pages]

Deploying cloudflare-docs with    Cloudflare Pages

Latest commit:	9cc9751
Status:	✅  Deploy successful!
Preview URL:	https://8b414b89.cloudflare-docs-7ou.pages.dev
Branch Preview URL:	https://api-next-documentation-links.cloudflare-docs-7ou.pages.dev

View logs

[github-actions]

Files with changes (up to 15)

Original Link	Updated Link
https://developers.cloudflare.com/ruleset-engine/rulesets-api/view/	https://api-next-documentation-links.cloudflare-docs-7ou.pages.dev/ruleset-engine/rulesets-api/view/
https://developers.cloudflare.com/page-shield/reference/page-shield-api/	https://api-next-documentation-links.cloudflare-docs-7ou.pages.dev/page-shield/reference/page-shield-api/
https://developers.cloudflare.com/logs/get-started/api-configuration/	https://api-next-documentation-links.cloudflare-docs-7ou.pages.dev/logs/get-started/api-configuration/
https://developers.cloudflare.com/waf/tools/lists/lists-api/endpoints/	https://api-next-documentation-links.cloudflare-docs-7ou.pages.dev/waf/tools/lists/lists-api/endpoints/
https://developers.cloudflare.com/security-center/intel-apis/	https://api-next-documentation-links.cloudflare-docs-7ou.pages.dev/security-center/intel-apis/
https://developers.cloudflare.com/waf/managed-rules/waf-exceptions/define-api/	https://api-next-documentation-links.cloudflare-docs-7ou.pages.dev/waf/managed-rules/waf-exceptions/define-api/
https://developers.cloudflare.com/load-balancing/pools/	https://api-next-documentation-links.cloudflare-docs-7ou.pages.dev/load-balancing/pools/
https://developers.cloudflare.com/waiting-room/reference/waiting-room-api/	https://api-next-documentation-links.cloudflare-docs-7ou.pages.dev/waiting-room/reference/waiting-room-api/
https://developers.cloudflare.com/cloudflare-for-platforms/cloudflare-for-saas/start/common-api-calls/	https://api-next-documentation-links.cloudflare-docs-7ou.pages.dev/cloudflare-for-platforms/cloudflare-for-saas/start/common-api-calls/
https://developers.cloudflare.com/firewall/api/cf-filters/endpoints/	https://api-next-documentation-links.cloudflare-docs-7ou.pages.dev/firewall/api/cf-filters/endpoints/
https://developers.cloudflare.com/firewall/api/cf-firewall-rules/endpoints/	https://api-next-documentation-links.cloudflare-docs-7ou.pages.dev/firewall/api/cf-firewall-rules/endpoints/
https://developers.cloudflare.com/load-balancing/monitors/	https://api-next-documentation-links.cloudflare-docs-7ou.pages.dev/load-balancing/monitors/
https://developers.cloudflare.com/waf/managed-rules/payload-logging/configure-api/	https://api-next-documentation-links.cloudflare-docs-7ou.pages.dev/waf/managed-rules/payload-logging/configure-api/
https://developers.cloudflare.com/waf/reference/migration-guides/waf-managed-rules-migration/	https://api-next-documentation-links.cloudflare-docs-7ou.pages.dev/waf/reference/migration-guides/waf-managed-rules-migration/
https://developers.cloudflare.com/waiting-room/additional-options/create-events/	https://api-next-documentation-links.cloudflare-docs-7ou.pages.dev/waiting-room/additional-options/create-events/

[pedrosousa]

We should probably also update:

• Target URLs of redirects pointing to the current API reference site. For example:

cloudflare-docs/public/_redirects

Line 647 in 28308f0

/images/cloudflare-images/upload-images/images-batch/ /api/operations/cloudflare-images-list-images 301

• Links in YAML files like changelogs also pointing to the current site. For example:

cloudflare-docs/src/content/changelogs/r2.yaml

Line 31 in 28308f0

- Add `minTLS` to response of [list custom domains](/api/operations/r2-list-custom-domains) endpoint.

cc: @crwaters16

[pedrosousa]

Also noticed that API URLs with parentheses aren't included in this PR yet. Example:
/api/operations/custom-hostname-for-a-zone-delete-custom-hostname-(-and-any-issued-ssl-certificates)

Probably related to the regex you used to capture existing links?

Btw, some of these URLs have escaped parentheses characters in the MDX source. For example:
/api/operations/zone-analytics-\(-deprecated\)-get-dashboard

[pedrosousa]

Some (apparently normal?) API links still need to be updated — found 174 search results for /api/operations/ across different documentation sections, including changelogs, notifications, and partials. Example:

cloudflare-docs/src/content/docs/cloudflare-one/identity/idp-integration/entra-id.mdx

Line 209 in 761df1a

You can require users to re-enter their credentials into Entra ID whenever they [re-authenticate their WARP session](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-sessions/). To configure this setting, make a [`PUT` request](/api/operations/access-identity-providers-update-an-access-identity-provider) and set the `prompt` parameter to either `login` or `select_account`.

Maybe rerunning the script will fix these occurrences?

[jacobbednarz]

Probably related to the regex you used to capture existing links?

there wasn't a regex used here; it was taking the existing URLs and mapping them to the current documentation URLs. if it isn't picked up, one of those are missing.

Also noticed that API URLs with parentheses aren't included in this PR yet. Example:
/api/operations/custom-hostname-for-a-zone-delete-custom-hostname-(-and-any-issued-ssl-certificates)

this one is due to workaround being used to not escape the parentheses (it's called an automatic link). in the source it is laid out as

To delete a custom hostname and any issued certificates using the API, send a [`DELETE` request](</api/operations/custom-hostname-for-a-zone-delete-custom-hostname-(-and-any-issued-ssl-certificates)>).

while valid, this doesn't get picked up as the URL is wrapped with <> violating the word boundary restriction we have on the replacement to prevent it from overlapping replacements. i'll update it to allow optional <> to wrap.

Btw, some of these URLs have escaped parentheses characters in the MDX source. For example:
/api/operations/zone-analytics-(-deprecated)-get-dashboard

these won't automatically get picked up as that is not in the source of the openapi schema which was used for mapping. we can manually update these ones.