dotnet/aspnetcore

UrlHelperExtensions.ActionLink docs are misleading regarding requiring protocol and host

Closed

#42,949 opened on Jul 27, 2022

View on GitHubContributor guide
 (2 comments) (1 reaction) (0 assignees)C# (10,653 forks)batch import
Docsarea-routinghelp wanted

Repository metrics

Stars
 (37,933 stars)
PR merge metrics
 (Avg merge 16d 9h) (258 merged PRs in 30d)

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

Research direction
Read the current documentation for ActionLink and understand how it resolves the URL when protocol and host are null. Update the documentation to clarify that absolute URLs can be generated based on the request context even without specifying protocol and host.
Tech stack
csharp
Domain
backenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85