dotnet/aspnetcore

UrlHelperExtensions.ActionLink docs are misleading regarding requiring protocol and host

Geschlossen

#42.949 geöffnet am 27.07.2022

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (1 Reaktion) (0 zugewiesene Personen)C# (10.653 Forks)batch import
Docsarea-routinghelp wanted

Repository-Metriken

Stars
 (37.933 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 16T 9h) (258 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Untersuchen Sie die Quelldatei UrlHelperExtensions.cs in Zeile 575 (https://github.com/dotnet/aspnetcore/blob/main/src/Mvc/Mvc.Core/src/UrlHelperExtensions.cs#L575). Verstehen Sie die aktuellen XML Dokumentationskommentare für die ActionLink Methode. Überprüfen Sie auch den in der Dokumentation erwähnten Abschnitt mit Hinweisen. Die Korrektur umfasst die Aktualisierung des Kommentars, um klarzustellen, dass die Methode eine absolute URL basierend auf dem aktuellen Anforderungskontext generiert, auch wenn Protokoll und Host weggelassen oder null sind. Stellen Sie sicher, dass die Sprache präzise und nicht irreführend ist.
Tech Stack
csharp
Domain
backenddocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C#
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85