search

cloudflare / cloudflare-docs

Cloudflare’s documentation
https://developers.cloudflare.com
Creative Commons Attribution 4.0 International
3.03k stars 4.32k forks source link

Hyperlint Monitor Alert #17617

Closed hyperlint-ai[bot] closed 1 week ago

hyperlint-ai[bot] commented 1 week ago

OpenAPI Monitor

🧪 Experimental feature

This report covers changes from October 17, 2024 to October 18, 2024.

Firewall

We found 19 endpoint changes for Firewall and scanned 36 files that related to these changes. Here are the results from the scanned files:

🚨Need updates:

Please review the changes and make the necessary updates.

🚨 firewall-rules-to-custom-rules.mdx triggered an alert and we found changes to propose. The changes to the file are as follows: [Line 12](https://github.com/cloudflare/cloudflare-docs/blob/cff09c57cf67cbe3b8979c36f0d715331f13b51b/src/content/docs/waf/reference/migration-guides/firewall-rules-to-custom-rules.mdx?plain=1#L12): Add a note about the removal of specific API paths without deprecation. [Line 116](https://github.com/cloudflare/cloudflare-docs/blob/cff09c57cf67cbe3b8979c36f0d715331f13b51b/src/content/docs/waf/reference/migration-guides/firewall-rules-to-custom-rules.mdx?plain=1#L116): Clarify that while the APIs are available, specific paths have been removed without deprecation. [Line 132](https://github.com/cloudflare/cloudflare-docs/blob/cff09c57cf67cbe3b8979c36f0d715331f13b51b/src/content/docs/waf/reference/migration-guides/firewall-rules-to-custom-rules.mdx?plain=1#L132): Add a note about the removal of specific API paths and its potential impact on the conversion process. The changes in the API were: - `/accounts/{account_id}/firewall/access_rules/rules` changed operation `GET` for operation ID: **ip-access-rules-for-an-account-list-ip-access-rules**. Specific change: ``` api path removed without deprecation ``` - `/accounts/{account_id}/firewall/access_rules/rules` changed operation `POST` for operation ID: **ip-access-rules-for-an-account-create-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/accounts/{account_id}/firewall/access_rules/rules/{rule_id}` changed operation `DELETE` for operation ID: **ip-access-rules-for-an-account-delete-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/accounts/{account_id}/firewall/access_rules/rules/{rule_id}` changed operation `GET` for operation ID: **ip-access-rules-for-an-account-get-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/accounts/{account_id}/firewall/access_rules/rules/{rule_id}` changed operation `PATCH` for operation ID: **ip-access-rules-for-an-account-update-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/user/firewall/access_rules/rules/{rule_id}` changed operation `DELETE` for operation ID: **ip-access-rules-for-a-user-delete-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/user/firewall/access_rules/rules/{rule_id}` changed operation `PATCH` for operation ID: **ip-access-rules-for-a-user-update-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/access_rules/rules/{rule_id}` changed operation `DELETE` for operation ID: **ip-access-rules-for-a-zone-delete-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/access_rules/rules/{rule_id}` changed operation `PATCH` for operation ID: **ip-access-rules-for-a-zone-update-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/lockdowns` changed operation `GET` for operation ID: **zone-lockdown-list-zone-lockdown-rules**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/lockdowns` changed operation `POST` for operation ID: **zone-lockdown-create-a-zone-lockdown-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}` changed operation `DELETE` for operation ID: **zone-lockdown-delete-a-zone-lockdown-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}` changed operation `GET` for operation ID: **zone-lockdown-get-a-zone-lockdown-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}` changed operation `PUT` for operation ID: **zone-lockdown-update-a-zone-lockdown-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/ua_rules` changed operation `GET` for operation ID: **user-agent-blocking-rules-list-user-agent-blocking-rules**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/ua_rules` changed operation `POST` for operation ID: **user-agent-blocking-rules-create-a-user-agent-blocking-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/ua_rules/{ua_rule_id}` changed operation `DELETE` for operation ID: **user-agent-blocking-rules-delete-a-user-agent-blocking-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/ua_rules/{ua_rule_id}` changed operation `GET` for operation ID: **user-agent-blocking-rules-get-a-user-agent-blocking-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/ua_rules/{ua_rule_id}` changed operation `PUT` for operation ID: **user-agent-blocking-rules-update-a-user-agent-blocking-rule**. Specific change: ``` api path removed without deprecation ```

❓May need updates:

Please review the changes and make the necessary updates.

⚠️ pathing-status.mdx triggered an alert but we didn't find any specific changes to make. You can see the API changes in the details. [Link to file.](https://github.com/cloudflare/cloudflare-docs/blob/cff09c57cf67cbe3b8979c36f0d715331f13b51b/src/content/docs/logs/reference/pathing-status.mdx?plain=1) The changes in the API were: - `/accounts/{account_id}/firewall/access_rules/rules` changed operation `GET` for operation ID: **ip-access-rules-for-an-account-list-ip-access-rules**. Specific change: ``` api path removed without deprecation ``` - `/accounts/{account_id}/firewall/access_rules/rules` changed operation `POST` for operation ID: **ip-access-rules-for-an-account-create-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/accounts/{account_id}/firewall/access_rules/rules/{rule_id}` changed operation `DELETE` for operation ID: **ip-access-rules-for-an-account-delete-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/accounts/{account_id}/firewall/access_rules/rules/{rule_id}` changed operation `GET` for operation ID: **ip-access-rules-for-an-account-get-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/accounts/{account_id}/firewall/access_rules/rules/{rule_id}` changed operation `PATCH` for operation ID: **ip-access-rules-for-an-account-update-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/user/firewall/access_rules/rules/{rule_id}` changed operation `DELETE` for operation ID: **ip-access-rules-for-a-user-delete-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/user/firewall/access_rules/rules/{rule_id}` changed operation `PATCH` for operation ID: **ip-access-rules-for-a-user-update-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/access_rules/rules/{rule_id}` changed operation `DELETE` for operation ID: **ip-access-rules-for-a-zone-delete-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/access_rules/rules/{rule_id}` changed operation `PATCH` for operation ID: **ip-access-rules-for-a-zone-update-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/lockdowns` changed operation `GET` for operation ID: **zone-lockdown-list-zone-lockdown-rules**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/lockdowns` changed operation `POST` for operation ID: **zone-lockdown-create-a-zone-lockdown-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}` changed operation `DELETE` for operation ID: **zone-lockdown-delete-a-zone-lockdown-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}` changed operation `GET` for operation ID: **zone-lockdown-get-a-zone-lockdown-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}` changed operation `PUT` for operation ID: **zone-lockdown-update-a-zone-lockdown-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/ua_rules` changed operation `GET` for operation ID: **user-agent-blocking-rules-list-user-agent-blocking-rules**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/ua_rules` changed operation `POST` for operation ID: **user-agent-blocking-rules-create-a-user-agent-blocking-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/ua_rules/{ua_rule_id}` changed operation `DELETE` for operation ID: **user-agent-blocking-rules-delete-a-user-agent-blocking-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/ua_rules/{ua_rule_id}` changed operation `GET` for operation ID: **user-agent-blocking-rules-get-a-user-agent-blocking-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/ua_rules/{ua_rule_id}` changed operation `PUT` for operation ID: **user-agent-blocking-rules-update-a-user-agent-blocking-rule**. Specific change: ``` api path removed without deprecation ```
⚠️ displayed-data.mdx triggered an alert but we didn't find any specific changes to make. You can see the API changes in the details. [Link to file.](https://github.com/cloudflare/cloudflare-docs/blob/cff09c57cf67cbe3b8979c36f0d715331f13b51b/src/content/docs/analytics/network-analytics/configure/displayed-data.mdx?plain=1) The changes in the API were: - `/accounts/{account_id}/firewall/access_rules/rules` changed operation `GET` for operation ID: **ip-access-rules-for-an-account-list-ip-access-rules**. Specific change: ``` api path removed without deprecation ``` - `/accounts/{account_id}/firewall/access_rules/rules` changed operation `POST` for operation ID: **ip-access-rules-for-an-account-create-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/accounts/{account_id}/firewall/access_rules/rules/{rule_id}` changed operation `DELETE` for operation ID: **ip-access-rules-for-an-account-delete-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/accounts/{account_id}/firewall/access_rules/rules/{rule_id}` changed operation `GET` for operation ID: **ip-access-rules-for-an-account-get-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/accounts/{account_id}/firewall/access_rules/rules/{rule_id}` changed operation `PATCH` for operation ID: **ip-access-rules-for-an-account-update-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/user/firewall/access_rules/rules/{rule_id}` changed operation `DELETE` for operation ID: **ip-access-rules-for-a-user-delete-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/user/firewall/access_rules/rules/{rule_id}` changed operation `PATCH` for operation ID: **ip-access-rules-for-a-user-update-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/access_rules/rules/{rule_id}` changed operation `DELETE` for operation ID: **ip-access-rules-for-a-zone-delete-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/access_rules/rules/{rule_id}` changed operation `PATCH` for operation ID: **ip-access-rules-for-a-zone-update-an-ip-access-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/lockdowns` changed operation `GET` for operation ID: **zone-lockdown-list-zone-lockdown-rules**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/lockdowns` changed operation `POST` for operation ID: **zone-lockdown-create-a-zone-lockdown-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}` changed operation `DELETE` for operation ID: **zone-lockdown-delete-a-zone-lockdown-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}` changed operation `GET` for operation ID: **zone-lockdown-get-a-zone-lockdown-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}` changed operation `PUT` for operation ID: **zone-lockdown-update-a-zone-lockdown-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/ua_rules` changed operation `GET` for operation ID: **user-agent-blocking-rules-list-user-agent-blocking-rules**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/ua_rules` changed operation `POST` for operation ID: **user-agent-blocking-rules-create-a-user-agent-blocking-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/ua_rules/{ua_rule_id}` changed operation `DELETE` for operation ID: **user-agent-blocking-rules-delete-a-user-agent-blocking-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/ua_rules/{ua_rule_id}` changed operation `GET` for operation ID: **user-agent-blocking-rules-get-a-user-agent-blocking-rule**. Specific change: ``` api path removed without deprecation ``` - `/zones/{zone_id}/firewall/ua_rules/{ua_rule_id}` changed operation `PUT` for operation ID: **user-agent-blocking-rules-update-a-user-agent-blocking-rule**. Specific change: ``` api path removed without deprecation ```
⚠️ account-permissions-table.mdx triggered an alert and we found changes to propose. The changes to the file are as follows: [Line 31](https://github.com/cloudflare/cloudflare-docs/blob/cff09c57cf67cbe3b8979c36f0d715331f13b51b/src/content/partials/fundamentals/account-permissions-table.mdx?plain=1#L31): Consider updating or removing the description if the read access to account firewall access rules is no longer possible due to the API removal. [Line 32](https://github.com/cloudflare/cloudflare-docs/blob/cff09c57cf67cbe3b8979c36f0d715331f13b51b/src/content/partials/fundamentals/account-permissions-table.mdx?plain=1#L32): Consider updating or removing the description if the write access to account firewall access rules is no longer possible due to the API removal. The changes in the API were: - `/accounts/{account_id}/firewall/access_rules/rules` changed operation `GET` for operation ID: **ip-access-rules-for-an-account-list-ip-access-rules**. Specific change: ``` api path removed without ...s_LogRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}` changed operation `PATCH` for operation ID: **updateZoneRulesetRule**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_ManagedChallengeRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}` changed operation `PATCH` for operation ID: **updateZoneRulesetRule**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_RedirectRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}` changed operation `PATCH` for operation ID: **updateZoneRulesetRule**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_RewriteRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}` changed operation `PATCH` for operation ID: **updateZoneRulesetRule**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_RouteRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}` changed operation `PATCH` for operation ID: **updateZoneRulesetRule**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_ScoreRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}` changed operation `PATCH` for operation ID: **updateZoneRulesetRule**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_ServeErrorRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}` changed operation `PATCH` for operation ID: **updateZoneRulesetRule**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_SetCacheSettingsRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}` changed operation `PATCH` for operation ID: **updateZoneRulesetRule**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_SetConfigRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}` changed operation `PATCH` for operation ID: **updateZoneRulesetRule**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_SkipRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_BlockRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_ChallengeRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_CompressResponseRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_DDoSDynamicRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_ExecuteRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_ForceConnectionCloseRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_JsChallengeRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_LogCustomFieldRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_LogRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_ManagedChallengeRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_RedirectRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_RewriteRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_RouteRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_ScoreRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_ServeErrorRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_SetCacheSettingsRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_SetConfigRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ``` - `/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}` changed operation `GET` for operation ID: **getZoneRulesetVersion**. Specific change: ``` the '/allOf[subschema #2]/result/allOf[subschema #2]/rules/items/allOf[#/components/schemas/rulesets_RequestRule]/oneOf[#/components/schemas/rulesets_SkipRule]/allOf[subschema #1: Rule]/ratelimit/score_response_header_name' response's property type/format changed from 'string'/'' to 'integer'/'' for status '200' ```

Storage

We found 3 endpoint changes for Storage and scanned 31 files that related to these changes. Here are the results from the scanned files:

❓May need updates:

Please review the changes and make the necessary updates.

⚠️ storage-options.mdx triggered an alert but we didn't find any specific changes to make. You can see the API changes in the details. [Link to file.](https://github.com/cloudflare/cloudflare-docs/blob/cff09c57cf67cbe3b8979c36f0d715331f13b51b/src/content/docs/workers/platform/storage-options.mdx?plain=1) The changes in the API were: - `/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}` changed operation `PUT` for operation ID: **workers-kv-namespace-write-key-value-pair-with-metadata**. Specific change: ``` removed the media type '' from the request body ``` - `/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}` changed operation `PUT` for operation ID: **workers-kv-namespace-write-key-value-pair-with-metadata**. Specific change: ``` deleted the 'query' request parameter 'expiration' ``` - `/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}` changed operation `PUT` for operation ID: **workers-kv-namespace-write-key-value-pair-with-metadata**. Specific change: ``` deleted the 'query' request parameter 'expiration_ttl' ```

wrangler Monitor

🧪 Experimental feature This scan covers changes from October 17, 2024 to October 18, 2024 and wrangler --version: 3.80.5 -> 3.81.0.

Scanned a total of 25 commands and found 0 updates.

Command Details

Found 25 commands with no updates. You can see all commands scanned in the details. ✅ `wrangler --help` ✅ `wrangler ai --help` ✅ `wrangler d1 --help` ✅ `wrangler delete --help` ✅ `wrangler deploy --help` ✅ `wrangler deployments --help` ✅ `wrangler dev --help` ✅ `wrangler dispatch-namespace --help` ✅ `wrangler docs --help` ✅ `wrangler hyperdrive --help` ✅ `wrangler init --help` ✅ `wrangler kv --help` ✅ `wrangler login --help` ✅ `wrangler logout --help` ✅ `wrangler mtls-certificate --help` ✅ `wrangler pages --help` ✅ `wrangler pubsub --help` ✅ `wrangler queues --help` ✅ `wrangler r2 --help` ✅ `wrangler rollback --help` ✅ `wrangler secret --help` ✅ `wrangler tail --help` ✅ `wrangler types --help` ✅ `wrangler vectorize --help` ✅ `wrangler whoami --help`
bllchmbrs commented 1 week ago

@pedrosousa , interesting case here.

re: OpenAPI

I looked up the live docs for the API operation: https://developers.cloudflare.com/api/operations/ip-access-rules-for-an-account-list-ip-access-rules and glanced through the docs that you had. It seems that there is actually a potential deprecation of these features but that this exact alert isn't accurate.

If it is a false positive, I have an actionable hypothesis as to what's going on here (and a way to test it), I just wanted to confirm that you don't think this is accurate before pursuing that.

Re: Wrangler

The wrangler scan is going full swing, I added every wrangler command so now we're tracking changes there. No alerts yet.

pedrosousa commented 1 week ago

Hi @bllchmbrs

IP Access rules, Zone Lockdown, and User Agent Blocking haven't been deprecated, only Firewall Rules. Not sure why the report said that they had been removed without any deprecation, because they're still available in the API reference website. Maybe another "remove & quickly add back" glitch that Hyperlint caught?

One possible reason for some kind of mix-up is that we have /firewall/ in the path for the API operations of these three features, and these tools are actually documented in the Web Application Firewall docs:

However, the Firewall Rules is a different product and its API is documented in a different place, with deprecation warnings.

Same thing for "possible impact in displayed-data.mdx file": It mentions Magic Firewall, which is a different product with distinct API operations, but still has firewall in the name (?).

(Eagerly waiting for Wrangler changes just to see the report... 👀 )

bllchmbrs commented 1 week ago

Re: OpenAPI, all this makes sense. I think my hypothesis is correct / I have things for our team to investigate. Should have some action items / changes for our meeting next week.

Re: Wrangler - I am so excited! I'm tracking the versions and yesterday we added all the wrangler commands. Any change in a CLI should trigger the pipeline and surface some real notifications.

We can close this out, look forward to chatting next week.