Commit bd921366 authored by Eric Dieckman's avatar Eric Dieckman
Browse files

Style cop

parent d5c6e31d

src/api/Api.csproj

+0 −8
Original line number Diff line number Diff line
@@ -9,12 +9,8 @@ 
  </PropertyGroup>



  <PropertyGroup>

    <TargetFramework>net8.0</TargetFramework>

    <Nullable>enable</Nullable>

    <ImplicitUsings>enable</ImplicitUsings>

    <AssemblyName>Cals.Visor.Api</AssemblyName>

    <RootNamespace>Cals.Visor.Api</RootNamespace>

    <ImplicitUsings>enable</ImplicitUsings>

    <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>

  </PropertyGroup>
@@ -49,10 +45,6 @@ 
    <ProjectReference Include="..\infrastructure\Infrastructure.csproj" />

  </ItemGroup>



  <ItemGroup>

    <Folder Include="SeedWork\" />

  </ItemGroup>







</Project>

src/api/Cals.Visor.Api.xml

+1 −1
Original line number Diff line number Diff line
@@ -151,7 +151,7 @@ 
            <param name="options">The configuration options.</param>

            <param name="loggerFactory">An <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> instance used to create loggers.</param>

        </member>

        <member name="M:Cals.Visor.Api.Identity.IdentityMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext,Cals.Cqrs.IRequestProcessor)">

        <member name="M:Cals.Visor.Api.Identity.IdentityMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext)">

            <summary>

            Processes a request to add the Visor identity to the user principal.

            </summary>

src/api/Cals.Visor.Web.xml

deleted100644 → 0
+0 −345
Original line number Diff line number Diff line 
<?xml version="1.0"?>

<doc>

    <assembly>

        <name>Cals.Visor.Api</name>

    </assembly>

    <members>

        <member name="T:Cals.Visor.Api.Authorization.AppGroups">

            <summary>

            Config object holding values for app groups from appsettings.

            </summary>

        </member>

        <member name="M:Cals.Visor.Api.Authorization.AuthenticationExtensions.GenerateAppDevAttributes(System.String)">

            <summary>

            Generates an list of user-defined attributes to mock a Shibboleth session for the specified username.

            </summary>

            <param name="username">Username of user to impersonate - valid values: ewdieckman, eewall, mtreleven, sjohnston3.</param>

            <returns></returns>

        </member>

        <member name="M:Cals.Visor.Api.Authorization.AuthorizationExtensions.AddPermissionsAuthorization(Microsoft.Extensions.DependencyInjection.IServiceCollection)">

            <summary>

            Adds authorization services to the specified <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.

            </summary>

            <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>

            <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>

        </member>

        <member name="M:Cals.Visor.Api.Authorization.AuthorizationExtensions.AddAuthorization(Microsoft.Extensions.DependencyInjection.IServiceCollection,Cals.Visor.Api.Authorization.AppGroups)">

            <summary>

            Adds authorization services to the specified <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. Also initializes the app groups.

            </summary>

            <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>

            <param name="appGroups"></param>

            <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>

        </member>

        <member name="T:Cals.Visor.Api.Authorization.AccessAppHandler">

            <summary>

            Handler for <see cref="T:Cals.Visor.Api.Authorization.AccessAppPermission"/>.

            </summary>

        </member>

        <member name="F:Cals.Visor.Api.Authorization.Policies.RequireAtLeastOneAppGroup">

            <summary>

            Allows access when client has at least one of the groups.

            </summary>

        </member>

        <member name="T:Cals.Visor.Api.Authorization.AccessAppPermission">

            <summary>

            Permission to simply access the app (minimum permission.

            </summary>

        </member>

        <member name="M:Cals.Visor.Api.Controllers.Api.AuthApiController.GetGroups">

            <summary>

            Returns a listing of all system groups, and all groups that the logged-in user is a member of.

            </summary>

        </member>

        <member name="T:Cals.Visor.Api.Helpers.AppConfig">

            <summary>

            Class to hold app config options from appsettings.

            </summary>

        </member>

        <member name="T:Cals.Visor.Api.Helpers.AppConfigActionFilter">

            <summary>

            Action filter to inject app config from appsettings into views.

            </summary>

        </member>

        <member name="T:Cals.Visor.Api.AppConfigGenerator">

            <summary>

            Generates an <see cref="T:Cals.Visor.Api.Helpers.AppConfig"/> from <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> and <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostEnvironment"/>.

            </summary>

        </member>

        <member name="M:Cals.Visor.Api.AppConfigGenerator.Create(Microsoft.Extensions.Configuration.IConfiguration,Microsoft.AspNetCore.Hosting.IWebHostEnvironment,System.String,System.Boolean)">

            <summary>

            Creates an <see cref="T:Cals.Visor.Api.Helpers.AppConfig"/> from the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> and <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostEnvironment"/>.

            </summary>

            <param name="configuration"></param>

            <param name="environment"></param>

            <param name="appConfigSection">name of the section in <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> where the app config resides.</param>

            <param name="environmentBranding">Determines if the environment name will be prefixed on the AppConfig's branding.</param>

            <returns></returns>

        </member>

        <member name="M:Cals.Visor.Api.Identity.ApplicationBuildingExtensions.UseAppIdentity(Microsoft.AspNetCore.Builder.IApplicationBuilder)">

            <summary>

            Enables use of the Visor user identity.

            </summary>

            <param name="app"></param>

            <returns></returns>

        </member>

        <member name="M:Cals.Visor.Api.Identity.ApplicationBuildingExtensions.UseAppIdentity(Microsoft.AspNetCore.Builder.IApplicationBuilder,Cals.Visor.Api.Identity.IdentityUserOptions)">

            <summary>

            Enables Visor user with the given options.

            </summary>

        </member>

        <member name="T:Cals.Visor.Api.Identity.IdentityMiddleware">

            <summary>

            Middleware to add this app user's identity to the ClaimsPrincipal.

            </summary>

        </member>

        <member name="M:Cals.Visor.Api.Identity.IdentityMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.Extensions.Options.IOptions{Cals.Visor.Api.Identity.IdentityUserOptions},Microsoft.Extensions.Logging.ILoggerFactory)">

            <summary>

            Initializes a new instance of the <see cref="T:Cals.Visor.Api.Identity.IdentityMiddleware"/> class.

            </summary>

            <param name="next">The next middleware in the pipeline.</param>

            <param name="options">The configuration options.</param>

            <param name="loggerFactory">An <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> instance used to create loggers.</param>

        </member>

        <member name="M:Cals.Visor.Api.Identity.IdentityMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext,Cals.Cqrs.IRequestProcessor)">

            <summary>

            Processes a request to add the Visor identity to the user principal.

            </summary>

            <param name="context"></param>

            <param name="requestProcessor"></param>

            <returns></returns>

        </member>

        <member name="T:Cals.Visor.Api.Identity.IdentityUserOptions">

            <summary>

            Options for Identity Middleware.

            </summary>

        </member>

        <member name="T:Cals.Visor.Api.ViewModels.MainMenu">

            <summary>

            View model used for the main menu.

            </summary>

        </member>

        <member name="T:Cals.Visor.Api.ViewModels.VueViewModel">

            <summary>

            Base class for view models containing initial Vue data.

            </summary>

        </member>

        <member name="P:Cals.Visor.Api.ViewModels.VueViewModel.VueData">

            <summary>

            Data to be serialized and injected into a Razor view.

            </summary>

        </member>

        <member name="M:Cals.Visor.Api.ViewModels.VueViewModel.VueDataToJson">

            <summary>

            Method to serialize the <see cref="P:Cals.Visor.Api.ViewModels.VueViewModel.VueData"/> field into JSON.

            </summary>

        </member>

        <member name="T:Cals.Visor.Identity.VisorUser">

            <summary>

            <see cref="T:Cals.Authentication.IApplicationUser"/> for the Directory Edit app.

            </summary>

        </member>

        <member name="T:Cals.Web.ErrorHandling.EndpointExtractor">

            <summary>

            Extracts endpoint information from the HttpContext.

            </summary>

        </member>

        <member name="T:Cals.Web.ErrorHandling.ErrorEmailCreator">

            <summary>

            Generates an email from the provided exception model.

            </summary>

        </member>

        <member name="M:Cals.Web.ErrorHandling.ErrorEmailCreator.CreateEmailHeader(System.String,System.String,System.Uri,System.String)">

            <summary>

            Creates the header section in the email.

            </summary>

            <param name="ip">Remote IP of the user.</param>

            <param name="user">Username of the user.</param>

            <param name="uri">Uri that generated the error.</param>

            <param name="errorType">Description text of what the error is.</param>

            <returns></returns>

        </member>

        <member name="M:Cals.Web.ErrorHandling.ErrorEmailCreator.CreateQuerySection(Microsoft.AspNetCore.Http.IQueryCollection)">

            <summary>

            Creates the Querystring section from the request querystring.

            </summary>

            <returns>A 2 element array holding the strings generated

            0 = plain text

            1 = html.

            </returns>

        </member>

        <member name="M:Cals.Web.ErrorHandling.ErrorEmailCreator.CreateHeadersSection(System.Collections.Generic.IDictionary{System.String,Microsoft.Extensions.Primitives.StringValues})">

            <summary>

            Creates the headers section from the request headers.

            </summary>

            <returns>A 2 element array holding the strings generated

            0 = plain text

            1 = html.

            </returns>

        </member>

        <member name="M:Cals.Web.ErrorHandling.ErrorEmailCreator.CreateRoutingSection(Cals.Web.ErrorHandling.EndpointModel,Microsoft.AspNetCore.Routing.RouteValueDictionary)">

            <summary>

            Creates the routing section from the request endpoint information and routing values dictionary.

            </summary>

            <returns>A 2 element array holding the strings generated

            0 = plain text

            1 = html.

            </returns>

        </member>

        <member name="T:Cals.Web.ErrorHandling.ErrorEmailModel">

            <summary>

            Holds data to be displayed in the error model.

            </summary>

        </member>

        <member name="P:Cals.Web.ErrorHandling.ErrorEmailModel.ErrorDetails">

            <summary>

            Detailed information about each exception in the stack.

            </summary>

        </member>

        <member name="P:Cals.Web.ErrorHandling.ErrorEmailModel.Query">

            <summary>

            Parsed query data.

            </summary>

        </member>

        <member name="P:Cals.Web.ErrorHandling.ErrorEmailModel.Cookies">

            <summary>

            Request cookies.

            </summary>

        </member>

        <member name="P:Cals.Web.ErrorHandling.ErrorEmailModel.Headers">

            <summary>

            Request headers.

            </summary>

        </member>

        <member name="P:Cals.Web.ErrorHandling.ErrorEmailModel.RouteValues">

            <summary>

            Request route values.

            </summary>

        </member>

        <member name="P:Cals.Web.ErrorHandling.ErrorEmailModel.Endpoint">

            <summary>

            Request endpoint.

            </summary>

        </member>

        <member name="P:Cals.Web.ErrorHandling.ErrorEmailModel.IpAddress">

            <summary>

            Requesting IP address.

            </summary>

        </member>

        <member name="P:Cals.Web.ErrorHandling.ErrorEmailModel.UserId">

            <summary>

            User ID of logged user.

            </summary>

        </member>

        <member name="P:Cals.Web.ErrorHandling.ErrorEmailModel.Uri">

            <summary>

            Original requesting URL.

            </summary>

        </member>

        <member name="P:Cals.Web.ErrorHandling.ErrorEmailModel.StatusCode">

            <summary>

            Status code for the error.

            </summary>

        </member>

        <member name="T:Cals.Web.ErrorHandling.ExceptionDetails">

            <summary>

            Contains details for individual exception messages.

            </summary>

        </member>

        <member name="P:Cals.Web.ErrorHandling.ExceptionDetails.Error">

            <summary>

            An individual exception.

            </summary>

        </member>

        <member name="P:Cals.Web.ErrorHandling.ExceptionDetails.StackFrames">

            <summary>

            The generated stack frames.

            </summary>

        </member>

        <member name="P:Cals.Web.ErrorHandling.ExceptionDetails.ErrorMessage">

            <summary>

            Gets or sets the summary message.

            </summary>

        </member>

        <member name="T:Cals.Helpers.StackTrace.StackFrameSourceCodeInfo">

            <summary>

            Contains the source code where the exception occurred.

            </summary>

        </member>

        <member name="P:Cals.Helpers.StackTrace.StackFrameSourceCodeInfo.Function">

            <summary>

            Function containing instruction.

            </summary>

        </member>

        <member name="P:Cals.Helpers.StackTrace.StackFrameSourceCodeInfo.File">

            <summary>

            File containing the instruction.

            </summary>

        </member>

        <member name="P:Cals.Helpers.StackTrace.StackFrameSourceCodeInfo.Line">

            <summary>

            The line number of the instruction.

            </summary>

        </member>

        <member name="P:Cals.Helpers.StackTrace.StackFrameSourceCodeInfo.PreContextLine">

            <summary>

            The line preceding the frame line.

            </summary>

        </member>

        <member name="P:Cals.Helpers.StackTrace.StackFrameSourceCodeInfo.PreContextCode">

            <summary>

            Lines of code before the actual error line(s).

            </summary>

        </member>

        <member name="P:Cals.Helpers.StackTrace.StackFrameSourceCodeInfo.ContextCode">

            <summary>

            Line(s) of code responsible for the error.

            </summary>

        </member>

        <member name="P:Cals.Helpers.StackTrace.StackFrameSourceCodeInfo.PostContextCode">

            <summary>

            Lines of code after the actual error line(s).

            </summary>

        </member>

        <member name="P:Cals.Helpers.StackTrace.StackFrameSourceCodeInfo.ErrorDetails">

            <summary>

            Specific error details for this stack frame.

            </summary>

        </member>

        <member name="M:Cals.Helpers.TypeNameHelper.GetTypeDisplayName(System.Type,System.Boolean,System.Boolean,System.Boolean,System.Char)">

            <summary>

            Pretty print a type name.

            </summary>

            <param name="type">The <see cref="T:System.Type"/>.</param>

            <param name="fullName"><c>true</c> to print a fully qualified name.</param>

            <param name="includeGenericParameterNames"><c>true</c> to include generic parameter names.</param>

            <param name="includeGenericParameters"><c>true</c> to include generic parameters.</param>

            <param name="nestedTypeDelimiter">Character to use as a delimiter in nested type names.</param>

            <returns>The pretty printed type name.</returns>

        </member>

        <member name="T:Cals.Api.Validation.ValidateModelAttribute">

            <summary>

            Validates a model state and returns a BadRequest for invalid models.

            </summary>

            <remarks>https://www.jerriepelser.com/blog/validation-response-aspnet-core-webapi/.</remarks>

        </member>

        <member name="T:Cals.Api.Validation.ValidationError">

            <summary>

            Response returned when a validation error occurs.

            </summary>

            <remarks>https://www.jerriepelser.com/blog/validation-response-aspnet-core-webapi/.</remarks>

        </member>

        <member name="T:Cals.Api.Validation.ValidationFailedResult">

            <summary>

            Action result that is returned for failed validation.

            </summary>

            <remarks>https://www.jerriepelser.com/blog/validation-response-aspnet-core-webapi/.</remarks>

        </member>

        <member name="T:Cals.Api.Validation.ValidationResultModel">

            <summary>

            Model of the result of validation of a model.

            </summary>

            <remarks>https://www.jerriepelser.com/blog/validation-response-aspnet-core-webapi/.</remarks>

        </member>

    </members>

</doc>

src/api/Identity/AuthenticationServiceExtensions.cs

+2 −2
Original line number Diff line number Diff line
@@ -3,6 +3,7 @@ using System.Net.Http.Headers; 
using System.Security.Claims;

using System.Text.Json;

using Cals.Authentication;

using Microsoft.AspNetCore.Authentication;

using Microsoft.AspNetCore.Authentication.JwtBearer;

using Microsoft.Extensions.Caching.Memory;

using Microsoft.IdentityModel.Protocols;
@@ -25,8 +26,7 @@ public static class AuthenticationServiceExtensions 
                    ? DevAuthenticationDefaults.AuthenticationScheme

                    : JwtBearerDefaults.AuthenticationScheme;





        var authBuilder = services.AddAuthentication(defaultAuthenticationScheme);

        AuthenticationBuilder authBuilder = services.AddAuthentication(defaultAuthenticationScheme);



        // Always add JWT support

        authBuilder.AddJwtBearer(options =>

src/api/Identity/DevAuthenticationDefaults.cs

+0 −1
Original line number Diff line number Diff line
@@ -21,5 +21,4 @@ public static class DevAuthenticationDefaults 
    /// Default value for <see cref="AuthenticationSchemeOptions.ClaimsIssuer"/>.

    /// </summary>

    public const string Issuer = "DevAuthentication";



}