Skip to content

Commit f5b5018

Browse files
javiercnjaviercn
committed
[Fixes #1958] Add and generate docs for the default UI
1 parent 04552f4 commit f5b5018

File tree

60 files changed

+1440
-50
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+1440
-50
lines changed

‎NuGetPackageVerifier.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
"Microsoft.AspNetCore.Identity.UI": {
88
"Exclusions": {
99
"DOC_MISSING": {
10-
"lib/netstandard2.0/Microsoft.AspNetCore.Identity.UI.dll": "This is a library with packaged UI",
1110
"lib/netstandard2.0/Microsoft.AspNetCore.Identity.UI.Views.V3.dll": "This assembly is generated and contains precompiled razor pages",
1211
"lib/netstandard2.0/Microsoft.AspNetCore.Identity.UI.Views.V4.dll": "This assembly is generated and contains precompiled razor pages"
1312
}

‎src/UI/Areas/Identity/Pages/V3/Account/AccessDenied.cshtml.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,16 @@
66
namespace Microsoft.AspNetCore.Identity.UI.V3.Pages.Account.Internal
77

88
{
9+
/// <summary>
10+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
11+
/// directly from your code. This API may change or be removed in future releases.
12+
/// </summary>
913
public class AccessDeniedModel : PageModel
1014
{
15+
/// <summary>
16+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
17+
/// directly from your code. This API may change or be removed in future releases.
18+
/// </summary>
1119
public void OnGet()
1220
{
1321
}

‎src/UI/Areas/Identity/Pages/V3/Account/ConfirmEmail.cshtml.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,18 @@
1010
namespace Microsoft.AspNetCore.Identity.UI.V3.Pages.Account.Internal
1111

1212
{
13+
/// <summary>
14+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
15+
/// directly from your code. This API may change or be removed in future releases.
16+
/// </summary>
1317
[AllowAnonymous]
1418
[IdentityDefaultUI(typeof(ConfirmEmailModel<>))]
1519
public abstract class ConfirmEmailModel : PageModel
1620
{
21+
/// <summary>
22+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
23+
/// directly from your code. This API may change or be removed in future releases.
24+
/// </summary>
1725
public virtual Task<IActionResult> OnGetAsync(string userId, string code) => throw new NotImplementedException();
1826
}
1927

‎src/UI/Areas/Identity/Pages/V3/Account/ExternalLogin.cshtml.cs

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,33 +14,77 @@
1414
namespace Microsoft.AspNetCore.Identity.UI.V3.Pages.Account.Internal
1515

1616
{
17+
/// <summary>
18+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
19+
/// directly from your code. This API may change or be removed in future releases.
20+
/// </summary>
1721
[AllowAnonymous]
1822
[IdentityDefaultUI(typeof(ExternalLoginModel<>))]
1923
public class ExternalLoginModel : PageModel
2024
{
25+
/// <summary>
26+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
27+
/// directly from your code. This API may change or be removed in future releases.
28+
/// </summary>
2129
[BindProperty]
2230
public InputModel Input { get; set; }
2331

32+
/// <summary>
33+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
34+
/// directly from your code. This API may change or be removed in future releases.
35+
/// </summary>
2436
public string ProviderDisplayName { get; set; }
2537

38+
/// <summary>
39+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
40+
/// directly from your code. This API may change or be removed in future releases.
41+
/// </summary>
2642
public string ReturnUrl { get; set; }
2743

44+
/// <summary>
45+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
46+
/// directly from your code. This API may change or be removed in future releases.
47+
/// </summary>
2848
[TempData]
2949
public string ErrorMessage { get; set; }
3050

51+
/// <summary>
52+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
53+
/// directly from your code. This API may change or be removed in future releases.
54+
/// </summary>
3155
public class InputModel
3256
{
57+
/// <summary>
58+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
59+
/// directly from your code. This API may change or be removed in future releases.
60+
/// </summary>
3361
[Required]
3462
[EmailAddress]
3563
public string Email { get; set; }
3664
}
3765

66+
/// <summary>
67+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
68+
/// directly from your code. This API may change or be removed in future releases.
69+
/// </summary>
3870
public virtual IActionResult OnGet() => throw new NotImplementedException();
3971

72+
/// <summary>
73+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
74+
/// directly from your code. This API may change or be removed in future releases.
75+
/// </summary>
4076
public virtual IActionResult OnPost(string provider, string returnUrl = null) => throw new NotImplementedException();
4177

78+
/// <summary>
79+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
80+
/// directly from your code. This API may change or be removed in future releases.
81+
/// </summary>
4282
public virtual Task<IActionResult> OnGetCallbackAsync(string returnUrl = null, string remoteError = null) => throw new NotImplementedException();
4383

84+
/// <summary>
85+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
86+
/// directly from your code. This API may change or be removed in future releases.
87+
/// </summary>
4488
public virtual Task<IActionResult> OnPostConfirmationAsync(string returnUrl = null) => throw new NotImplementedException();
4589
}
4690

‎src/UI/Areas/Identity/Pages/V3/Account/ForgotPassword.cshtml.cs

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,40 @@
1313
namespace Microsoft.AspNetCore.Identity.UI.V3.Pages.Account.Internal
1414

1515
{
16+
/// <summary>
17+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
18+
/// directly from your code. This API may change or be removed in future releases.
19+
/// </summary>
1620
[AllowAnonymous]
1721
[IdentityDefaultUI(typeof(ForgotPasswordModel<>))]
1822
public abstract class ForgotPasswordModel : PageModel
1923
{
24+
/// <summary>
25+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
26+
/// directly from your code. This API may change or be removed in future releases.
27+
/// </summary>
2028
[BindProperty]
2129
public InputModel Input { get; set; }
2230

31+
/// <summary>
32+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
33+
/// directly from your code. This API may change or be removed in future releases.
34+
/// </summary>
2335
public class InputModel
2436
{
37+
/// <summary>
38+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
39+
/// directly from your code. This API may change or be removed in future releases.
40+
/// </summary>
2541
[Required]
2642
[EmailAddress]
2743
public string Email { get; set; }
2844
}
2945

46+
/// <summary>
47+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
48+
/// directly from your code. This API may change or be removed in future releases.
49+
/// </summary>
3050
public virtual Task<IActionResult> OnPostAsync() => throw new NotImplementedException();
3151
}
3252

‎src/UI/Areas/Identity/Pages/V3/Account/ForgotPasswordConfirmation.cshtml.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,17 @@
77
namespace Microsoft.AspNetCore.Identity.UI.V3.Pages.Account.Internal
88

99
{
10+
/// <summary>
11+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
12+
/// directly from your code. This API may change or be removed in future releases.
13+
/// </summary>
1014
[AllowAnonymous]
1115
public class ForgotPasswordConfirmation : PageModel
1216
{
17+
/// <summary>
18+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
19+
/// directly from your code. This API may change or be removed in future releases.
20+
/// </summary>
1321
public void OnGet()
1422
{
1523
}

‎src/UI/Areas/Identity/Pages/V3/Account/Lockout.cshtml.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,17 @@
77
namespace Microsoft.AspNetCore.Identity.UI.V3.Pages.Account.Internal
88

99
{
10+
/// <summary>
11+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
12+
/// directly from your code. This API may change or be removed in future releases.
13+
/// </summary>
1014
[AllowAnonymous]
1115
public class LockoutModel : PageModel
1216
{
17+
/// <summary>
18+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
19+
/// directly from your code. This API may change or be removed in future releases.
20+
/// </summary>
1321
public void OnGet()
1422
{
1523
}

‎src/UI/Areas/Identity/Pages/V3/Account/Login.cshtml.cs

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,36 +15,80 @@
1515
namespace Microsoft.AspNetCore.Identity.UI.V3.Pages.Account.Internal
1616

1717
{
18+
/// <summary>
19+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
20+
/// directly from your code. This API may change or be removed in future releases.
21+
/// </summary>
1822
[AllowAnonymous]
1923
[IdentityDefaultUI(typeof(LoginModel<>))]
2024
public abstract class LoginModel : PageModel
2125
{
26+
/// <summary>
27+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
28+
/// directly from your code. This API may change or be removed in future releases.
29+
/// </summary>
2230
[BindProperty]
2331
public InputModel Input { get; set; }
2432

33+
/// <summary>
34+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
35+
/// directly from your code. This API may change or be removed in future releases.
36+
/// </summary>
2537
public IList<AuthenticationScheme> ExternalLogins { get; set; }
2638

39+
/// <summary>
40+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
41+
/// directly from your code. This API may change or be removed in future releases.
42+
/// </summary>
2743
public string ReturnUrl { get; set; }
2844

45+
/// <summary>
46+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
47+
/// directly from your code. This API may change or be removed in future releases.
48+
/// </summary>
2949
[TempData]
3050
public string ErrorMessage { get; set; }
3151

52+
/// <summary>
53+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
54+
/// directly from your code. This API may change or be removed in future releases.
55+
/// </summary>
3256
public class InputModel
3357
{
58+
/// <summary>
59+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
60+
/// directly from your code. This API may change or be removed in future releases.
61+
/// </summary>
3462
[Required]
3563
[EmailAddress]
3664
public string Email { get; set; }
3765

66+
/// <summary>
67+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
68+
/// directly from your code. This API may change or be removed in future releases.
69+
/// </summary>
3870
[Required]
3971
[DataType(DataType.Password)]
4072
public string Password { get; set; }
4173

74+
/// <summary>
75+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
76+
/// directly from your code. This API may change or be removed in future releases.
77+
/// </summary>
4278
[Display(Name = "Remember me?")]
4379
public bool RememberMe { get; set; }
4480
}
4581

82+
/// <summary>
83+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
84+
/// directly from your code. This API may change or be removed in future releases.
85+
/// </summary>
4686
public virtual Task OnGetAsync(string returnUrl = null) => throw new NotImplementedException();
4787

88+
/// <summary>
89+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
90+
/// directly from your code. This API may change or be removed in future releases.
91+
/// </summary>
4892
public virtual Task<IActionResult> OnPostAsync(string returnUrl = null) => throw new NotImplementedException();
4993
}
5094

‎src/UI/Areas/Identity/Pages/V3/Account/LoginWith2fa.cshtml.cs

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,67 @@
1212
namespace Microsoft.AspNetCore.Identity.UI.V3.Pages.Account.Internal
1313

1414
{
15+
/// <summary>
16+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
17+
/// directly from your code. This API may change or be removed in future releases.
18+
/// </summary>
1519
[AllowAnonymous]
1620
[IdentityDefaultUI(typeof(LoginWith2faModel<>))]
1721
public abstract class LoginWith2faModel : PageModel
1822
{
23+
/// <summary>
24+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
25+
/// directly from your code. This API may change or be removed in future releases.
26+
/// </summary>
1927
[BindProperty]
2028
public InputModel Input { get; set; }
2129

30+
/// <summary>
31+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
32+
/// directly from your code. This API may change or be removed in future releases.
33+
/// </summary>
2234
public bool RememberMe { get; set; }
2335

36+
/// <summary>
37+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
38+
/// directly from your code. This API may change or be removed in future releases.
39+
/// </summary>
2440
public string ReturnUrl { get; set; }
2541

42+
/// <summary>
43+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
44+
/// directly from your code. This API may change or be removed in future releases.
45+
/// </summary>
2646
public class InputModel
2747
{
48+
/// <summary>
49+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
50+
/// directly from your code. This API may change or be removed in future releases.
51+
/// </summary>
2852
[Required]
2953
[StringLength(7, ErrorMessage = "The {0} must be at least {2} and at max {1} characters long.", MinimumLength = 6)]
3054
[DataType(DataType.Text)]
3155
[Display(Name = "Authenticator code")]
3256
public string TwoFactorCode { get; set; }
3357

58+
/// <summary>
59+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
60+
/// directly from your code. This API may change or be removed in future releases.
61+
/// </summary>
3462
[Display(Name = "Remember this machine")]
3563
public bool RememberMachine { get; set; }
3664
}
3765

66+
/// <summary>
67+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
68+
/// directly from your code. This API may change or be removed in future releases.
69+
/// </summary>
3870
public virtual Task<IActionResult> OnGetAsync(bool rememberMe, string returnUrl = null) => throw new NotImplementedException();
3971

72+
/// <summary>
73+
/// This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
74+
/// directly from your code. This API may change or be removed in future releases.
75+
/// </summary>
4076
public virtual Task<IActionResult> OnPostAsync(bool rememberMe, string returnUrl = null) => throw new NotImplementedException();
4177
}
4278

0 commit comments

Comments
 (0)