Skip to content

Update routing.md#36805

Merged
guardrex merged 4 commits intodotnet:mainfrom
jz-k:patch-1
Mar 29, 2026
Merged

Update routing.md#36805
guardrex merged 4 commits intodotnet:mainfrom
jz-k:patch-1

Conversation

@jz-k
Copy link
Copy Markdown
Contributor

@jz-k jz-k commented Feb 25, 2026

Updated language to clarify the purpose of Route constraint required. The phrase "non-parameter value" was awkward. The updated language clarifies that an explicit value is required, and I hope is less muddy. "Non-parameter value" gave me pause, since we are applying the attribute to a parameter.


Internal previews

📄 File 🔗 Preview link
aspnetcore/fundamentals/routing.md Routing in ASP.NET Core

Updated language to clarify the purpose of Route constraint `required`. The phrase "non-parameter" value was awkward. The updated language clarifies that an explicit value is required, and I hope is less muddy.
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the routing documentation to clarify what the required route constraint does during URL generation, replacing the previously awkward “non-parameter value” phrasing.

Changes:

  • Reworded the required route constraint description to emphasize needing an explicitly provided value during URL generation.
  • Minor table row formatting alignment adjustments for the required, file, and nonfile rows.

@guardrex
Copy link
Copy Markdown
Collaborator

AI is correct to suggest updating the INCLUDE file (routing3-7.md) for prior versions with the change ...

Also, the <=7.0 content included from fundamentals/routing/includes/routing3-7.md still uses the old “non-parameter value” phrasing for the required constraint; updating that include would keep the guidance consistent across monikers.

I recommend adding a commit to update it to match ...

Enforces that an explicit value (not an ambient value) is present during URL generation.

@guardrex guardrex self-assigned this Mar 17, 2026
Copy link
Copy Markdown
Collaborator

@guardrex guardrex left a comment

Choose a reason for hiding this comment

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

Thanks for this, @jz-k! Please make the recommended updates, and I'll ping Tom for a final review before we merge this.

jz-k and others added 3 commits March 23, 2026 10:56
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Clarified the description of the 'required' constraint in routing documentation.
@guardrex
Copy link
Copy Markdown
Collaborator

Thanks @jz-k ... Please sign the CLA ☝️ if you agree with its terms. We can't accept a PR unless the CLA is reviewed and signed.

@jz-k
Copy link
Copy Markdown
Contributor Author

jz-k commented Mar 23, 2026

@dotnet-policy-service agree

@guardrex
Copy link
Copy Markdown
Collaborator

@cmastr ... The CLA flagging has been broken like this for years ... really as long as I can remember. The CLA notice often appears well after the PR has been submitted and after the dev and our team has had interaction on it, even with additional commits arriving. We were told at the outset not to even look at the content of a PR without a signed CLA, but that's impossible with the CLA notice popping up so late.

@guardrex guardrex requested a review from tdykstra March 23, 2026 15:23
Copy link
Copy Markdown
Contributor

@tdykstra tdykstra left a comment

Choose a reason for hiding this comment

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

Thank you! The revised language is much better than the original.

@guardrex guardrex dismissed their stale review March 29, 2026 23:56

Approved by tdykstra.

@guardrex guardrex merged commit 8dd8f7a into dotnet:main Mar 29, 2026
4 checks passed
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.

4 participants