Skip to content

[RUN-4518] Document nodeFilter URL parameter for job linking#1827

Open
ltamaster wants to merge 2 commits into
6.1.0from
RUN-4518-nodefilter-url-param
Open

[RUN-4518] Document nodeFilter URL parameter for job linking#1827
ltamaster wants to merge 2 commits into
6.1.0from
RUN-4518-nodefilter-url-param

Conversation

@ltamaster

Copy link
Copy Markdown
Contributor

Summary

Documents the new ?nodeFilter= URL query parameter introduced in rundeck/rundeck#10194.

File changed: docs/manual/jobs/job-options.md — "Linking to Jobs and providing option values" section.

Changes:

  • Renamed "Query Parameters format for options" → "Supported query parameters" to reflect the expanded list
  • Added nodeFilter entry with the nodeFilterEditable: true requirement clearly stated
  • Added a combined usage example showing nodeFilter alongside opt.NAME parameters

Release Notes

Add ?nodeFilter= URL parameter support to the Job linking section. When a Job has Node Filter set to Editable, you can now pre-populate the node filter via URL using ?nodeFilter=<filter expression>, enabling deep-linking workflows such as incident response integrations (e.g. ServiceNow) that include the target hostname.

Related

Add nodeFilter to the supported query parameters in the "Linking to Jobs
and providing option values" section. Includes the nodeFilterEditable
requirement and a combined usage example.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@ltamaster ltamaster requested review from a team and Copilot June 25, 2026 19:09
@ltamaster ltamaster added this to the 6.1.0 milestone Jun 25, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the Rundeck documentation to describe the newly supported nodeFilter URL query parameter when deep-linking to Job pages, clarifying how it behaves when a Job’s node filter is editable.

Changes:

  • Renames the query-parameter subsection to “Supported query parameters”.
  • Documents nodeFilter (including the nodeFilterEditable: true requirement).
  • Adds an example combining nodeFilter with opt.NAME parameters.

Comment thread docs/manual/jobs/job-options.md Outdated
Per Copilot review: clarify that nodeFilter values also require URL
encoding, with a concrete example of filter syntax characters.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@fdevans fdevans changed the base branch from 4.0.x to 6.1.0 June 25, 2026 19:39
@fdevans fdevans changed the title RUN-4518: Document nodeFilter URL parameter for job linking [RUN-4518] Document nodeFilter URL parameter for job linking Jun 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants