Hyperlint Monitor Updates

[hyperlint-ai]

CLI Change Report

This report covers changes from October 23, 2024 to October 29, 2024 for the wrangler CLI monitor source. This is a result of a scan for version wrangler --version: 3.82.0 -> 3.83.0.

Scanned a total of 173 commands and found 2 updates.

CLI Command Updates

wrangler r2 bucket notification create --help - Command output changed 3 potential file updates

Command Output

wrangler r2 bucket notification create <bucket>

Create an event notification rule for an R2 bucket

POSITIONALS
  bucket  The name of the R2 bucket to create an event notification rule for  [string] [required]

GLOBAL FLAGS
  -j, --experimental-json-config  Experimental: support wrangler.json  [boolean]
  -c, --config                    Path to .toml configuration file  [string]
  -e, --env                       Environment to use for operations and .env files  [string]
  -h, --help                      Show help  [boolean]
  -v, --version                   Show version number  [boolean]

OPTIONS
      --event-types, --event-type  The type of event(s) that will emit event notifications  [array] [required] [choices: "object-create", "object-delete"]
      --prefix                     The prefix that an object must match to emit event notifications (note: regular expressions not supported)  [string]
      --suffix                     The suffix that an object must match to emit event notifications (note: regular expressions not supported)  [string]
      --queue                      The name of the queue that will receive event notification messages  [string] [required]
  -J, --jurisdiction               The jurisdiction where the bucket exists  [string]
      --description                A description that can be used to identify the event notification rule after creation  [string]

Here's what changed:

--- 3.82.0


+++ 3.83.0


@@ -18,3 +18,4 @@

       --suffix                     The suffix that an object must match to emit event notifications (note: regular expressions not supported)  [string]
       --queue                      The name of the queue that will receive event notification messages  [string] [required]
   -J, --jurisdiction               The jurisdiction where the bucket exists  [string]
+      --description                A description that can be used to identify the event notification rule after creation  [string]

Potential File Changes

src/content/docs/workers/wrangler/commands.mdx
Add the new --description option to the list of options for the wrangler r2 bucket notification create command to reflect the latest changes in the command output.

event-notifications.mdx Line 37
Consider adding the optional --description parameter to the command to allow users to add a description to their event notification rule. Example: npx wrangler r2 bucket notification create <BUCKET_NAME> --event-type <EVENT_TYPE> --queue <QUEUE_NAME> --description "<DESCRIPTION>".

upload-logs-event-notifications.mdx Line 148
Consider adding the new --description option to the command to inform users of this new feature. This option allows users to add a description to the event notification rule, which can be useful for identification purposes.

wrangler secret delete --help - Command output changed 0 potential file updates

Command Output

⛅️ wrangler 3.83.0
-------------------

wrangler secret delete <key>

Delete a secret variable from a Worker

POSITIONALS
  key  The variable name to be accessible in the Worker  [string] [required]

GLOBAL FLAGS
  -j, --experimental-json-config  Experimental: support wrangler.json  [boolean]
  -c, --config                    Path to .toml configuration file  [string]
  -e, --env                       Environment to use for operations and .env files  [string]
  -h, --help                      Show help  [boolean]
  -v, --version                   Show version number  [boolean]

OPTIONS
      --name  Name of the Worker  [string]

Here's what changed:

--- 3.82.0


+++ 3.83.0


@@ -1,5 +1,5 @@

 
- ⛅️ wrangler 3.82.0
+ ⛅️ wrangler 3.83.0
 -------------------
 
 wrangler secret delete <key>

Potential File Changes

No changes necessary based on these changes.

---

OpenAPI Change Report

This report covers changes from October 23, 2024 to October 29, 2024 for the https://raw.githubusercontent.com/cloudflare/api-schemas/main/openapi.json OpenAPI monitor source.

⚠️ API Path Update

Added paths

• /accounts/{account_id}/ai-gateway/evaluation-types
• /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets
• /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets/{id}
• /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations
• /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations/{id}
• /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}
• /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}/request
• /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}/response

⚠️ API Method Update

/accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom/{domain_name}

• Added: get

/zones/{zone_id}/snippets/snippet_rules

• Added: delete

[bllchmbrs]

@pedrosousa , we're back!

Check out the CLI updates - quite accurate. We had to do a bunch of work around the APIs, so it's not ready to recommend changes.

[pedrosousa]

@jonesphillip Can you please check if the proposed doc changes related to Wrangler commands would make sense?

We'd be adding the new --description option for the wrangler r2 bucket notification create command to Dev Docs — I think it would make sense to add it to the Commands reference page, at least (first proposal below).

Potential File Changes

src/content/docs/workers/wrangler/commands.mdx Add the new --description option to the list of options for the wrangler r2 bucket notification create command to reflect the latest changes in the command output.

event-notifications.mdx Line 37 Consider adding the optional --description parameter to the command to allow users to add a description to their event notification rule. Example: npx wrangler r2 bucket notification create <BUCKET_NAME> --event-type <EVENT_TYPE> --queue <QUEUE_NAME> --description "<DESCRIPTION>".

upload-logs-event-notifications.mdx Line 148 Consider adding the new --description option to the command to inform users of this new feature. This option allows users to add a description to the event notification rule, which can be useful for identification purposes.

[pedrosousa]

The reference page has already been updated in #17641, so I'll close this PR.

@bllchmbrs Should we be receiving more issues related to CLI changes, or are you making adjustments? I think we've had some (small) changes recently.