Skip to content

Add System.Uri and System.UriBuilder threat model references to API docs #12418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
+22 −2
Open

Add System.Uri and System.UriBuilder threat model references to API docs #12418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70050b6
Add System.Uri and System.UriBuilder threat model references to API docs
Copilot Mar 18, 2026
15fcfe8
Apply suggestions from code review
MihaZupan Mar 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions xml/System/Uri.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,18 @@
</Attributes>
<Docs>
<summary>Provides an object representation of a uniform resource identifier (URI) and easy access to the parts of the URI.</summary>
<remarks>For more information about this API, see <see href="/dotnet/fundamentals/runtime-libraries/system-uri">Supplemental API remarks for Uri</see>.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

For more information about this API, see [Supplemental API remarks for Uri](/dotnet/fundamentals/runtime-libraries/system-uri).

Review the following threat model documents for more details about the design and security considerations of <xref:System.Uri> and <xref:System.UriBuilder>:

- [System.Uri threat model](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Private.Uri/docs/System.Uri%20Threat%20Model.md)
- [System.UriBuilder threat model](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Private.Uri/docs/System.UriBuilder%20Threat%20Model.md)

]]></format>
</remarks>
<example>
<format type="text/markdown"><![CDATA[
The following example creates an instance of the <xref:System.Uri> class and uses it to perform a GET request with <xref:System.Net.Http.HttpClient>.
Expand All @@ -124,8 +135,10 @@ The following code snippet shows example values of the various properties on the
<altmember cref="M:System.Uri.IsWellFormedOriginalString" />
<altmember cref="T:System.UriBuilder" />
<related type="Article" href="/dotnet/framework/network-programming/changes-to-the-system-uri-namespace-in-version-2-0">Changes to the System.Uri namespace in Version 2.0</related>
<related type="Article" href="/dotnet/framework/network-programming/international-resource-identifier-support-in-system-uri">International Resource Identifier Support in System.UriSystem.Uri</related>
<related type="Article" href="/dotnet/framework/network-programming/international-resource-identifier-support-in-system-uri">International Resource Identifier Support in System.Uri</related>
<related type="Article" href="/dotnet/framework/network-programming/">Network Programming in the .NET Framework</related>
<related type="ExternalDocumentation" href="https://github.com/dotnet/runtime/blob/main/src/libraries/System.Private.Uri/docs/System.Uri%20Threat%20Model.md">System.Uri threat model</related>
<related type="ExternalDocumentation" href="https://github.com/dotnet/runtime/blob/main/src/libraries/System.Private.Uri/docs/System.UriBuilder%20Threat%20Model.md">System.UriBuilder threat model</related>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
Expand Down
7 changes: 7 additions & 0 deletions xml/System/UriBuilder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,16 @@

The <xref:System.UriBuilder> properties provide read/write access to the read-only <xref:System.Uri> properties so that they can be modified.

Review the following threat model documents for more details about the design and security considerations of <xref:System.Uri> and <xref:System.UriBuilder>:

- [System.Uri threat model](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Private.Uri/docs/System.Uri%20Threat%20Model.md)
- [System.UriBuilder threat model](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Private.Uri/docs/System.UriBuilder%20Threat%20Model.md)

]]></format>
</remarks>
<altmember cref="T:System.Uri" />
<related type="ExternalDocumentation" href="https://github.com/dotnet/runtime/blob/main/src/libraries/System.Private.Uri/docs/System.Uri%20Threat%20Model.md">System.Uri threat model</related>
<related type="ExternalDocumentation" href="https://github.com/dotnet/runtime/blob/main/src/libraries/System.Private.Uri/docs/System.UriBuilder%20Threat%20Model.md">System.UriBuilder threat model</related>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
Expand Down
Loading