starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Help links in the Event Rules form provide unhelpful information #9330

New Issue
Closed
opened 2025-12-29 20:48:36 +01:00 by adam · 1 comment
adam commented 2025-12-29 20:48:36 +01:00
Owner
Copy Link

Originally created by @rboucher-me on GitHub (Mar 7, 2024).

Deployment Type

NetBox Cloud

NetBox Version

v3.7.3

Python Version

3.11

Steps to Reproduce

  1. Create or Edit an Event Rule (Operations > Event Rules > +Add)
  2. Scroll down to "Conditions" input text box
  3. Click on "JSON" help link below it (Enter parameters to pass to the action in JSON format.)
  4. Scroll down to "Action data" input text box
  5. Click on "JSON" help link below it (Enter parameters to pass to the action in JSON format.)

In both cases, the links take you to the json.org homepage, which does not provide relevant information.

Expected Behavior

The "Conditions" text box should provide help links to the following documentation sections:

  • Event Rules (ideally expanded to include information about the available context data, which I believe is only data)
  • Conditions

The "Action data" text box should provide a help link to an expanded version of Event Rules that includes information about the available context data (which I believe is event, model, timestamp, username, request_id, and data).

Observed Behavior

Help links go to json.org

Originally created by @rboucher-me on GitHub (Mar 7, 2024). ### Deployment Type NetBox Cloud ### NetBox Version v3.7.3 ### Python Version 3.11 ### Steps to Reproduce 1. Create or Edit an Event Rule (Operations > Event Rules > +Add) 2. Scroll down to "Conditions" input text box 3. Click on "JSON" help link below it (Enter parameters to pass to the action in JSON format.) 4. Scroll down to "Action data" input text box 5. Click on "JSON" help link below it (Enter parameters to pass to the action in JSON format.) In both cases, the links take you to the [json.org](https://www.json.org/json-en.html) homepage, which does not provide relevant information. ### Expected Behavior The "Conditions" text box should provide help links to the following documentation sections: - [Event Rules](https://docs.netbox.dev/en/stable/features/event-rules/) (ideally expanded to include information about the available context data, which I believe is only `data`) - [Conditions](https://docs.netbox.dev/en/stable/reference/conditions/) The "Action data" text box should provide a help link to an expanded version of [Event Rules](https://docs.netbox.dev/en/stable/features/event-rules/) that includes information about the available context data (which I believe is `event`, `model`, `timestamp`, `username`, `request_id`, and `data`). ### Observed Behavior Help links go to [json.org](https://www.json.org/json-en.html)
adam closed this issue 2025-12-29 20:48:36 +01:00
adam commented 2025-12-29 20:48:36 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Mar 8, 2024):

The hyperlinks provided in the form field help texts are correct. The intent is merely to indicate to the user the supported data format, in case they are not familiar with JSON.

The "Action data" text box should provide a help link to an expanded version of Event Rules that includes information about the available context data (which I believe is event, model, timestamp, username, request_id, and data).

There is no such context; any optional action data associated with an event rule is completely arbitrary.

@jeremystretch commented on GitHub (Mar 8, 2024): The hyperlinks provided in the form field help texts are correct. The intent is merely to indicate to the user the supported data format, in case they are not familiar with JSON. > The "Action data" text box should provide a help link to an expanded version of [Event Rules](https://docs.netbox.dev/en/stable/features/event-rules/) that includes information about the available context data (which I believe is event, model, timestamp, username, request_id, and data). There is no such context; any optional action data associated with an event rule is completely arbitrary.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#9330
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?