dotnet/aspnetcore

UrlHelperExtensions.ActionLink docs are misleading regarding requiring protocol and host

Open

#42,949 opened on Jul 27, 2022

View on GitHub
 (2 comments) (1 reaction) (0 assignees)C# (37,933 stars) (10,653 forks)batch import
Docsarea-routinghelp wanted

Description

Is there an existing issue for this?

  • I have searched the existing issues

Describe the bug

the docs state

Generates an absolute URL if the protocol and host are non-null. See the remarks section for important security information.

but if you omit passing values or pass null it still generates an absolute URL, seeming based on the host header a request scheme of the request from http context https://github.com/dotnet/aspnetcore/blob/main/src/Mvc/Mvc.Core/src/UrlHelperExtensions.cs#L575

Expected Behavior

expect docs to not indicate absolute url requires thsoe params to be not null, should mention where it gets those values from if they are omitted or passed as null

Steps To Reproduce

n/a

Exceptions (if any)

n/a

.NET Version

6

Anything else?

No response

Contributor guide

Tech stack
csharp
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with ASP.NET Core routingUnderstanding of URL generation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Examine the source file UrlHelperExtensions.cs at line 575 (https://github.com/dotnet/aspnetcore/blob/main/src/Mvc/Mvc.Core/src/UrlHelperExtensions.cs#L575). Understand the current XML documentation comments for the ActionLink method. Also check the remarks section mentioned in the docs. The fix involves updating the comment to clarify that the method generates an absolute URL based on the current request context even when protocol and host are omitted or null. Ensure the language is accurate and not misleading.