From 95627ee1d3884c79a7932dd369c773d9b7375fbe Mon Sep 17 00:00:00 2001 From: "Collin M. Barrett" Date: Sun, 4 Oct 2020 16:00:48 -0500 Subject: [PATCH] =?UTF-8?q?docs(directory):=20=F0=9F=93=9D=20document=20en?= =?UTF-8?q?dpoints?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../FilterLists.Directory.Api/.editorconfig | 4 ++++ .../Controllers/LanguagesController.cs | 5 +++++ .../Controllers/LicensesController.cs | 5 +++++ .../Controllers/ListsController.cs | 14 ++++++++++++-- .../Controllers/MaintainersController.cs | 5 +++++ .../Controllers/SoftwareController.cs | 5 +++++ .../Controllers/SyntaxesController.cs | 5 +++++ .../Controllers/TagsController.cs | 5 +++++ .../FilterLists.Directory.Api.csproj | 1 + .../FilterLists.Directory.Api/SwaggerExtensions.cs | 6 ++++++ 10 files changed, 53 insertions(+), 2 deletions(-) create mode 100644 services/Directory/FilterLists.Directory.Api/.editorconfig diff --git a/services/Directory/FilterLists.Directory.Api/.editorconfig b/services/Directory/FilterLists.Directory.Api/.editorconfig new file mode 100644 index 000000000..bbc524b6f --- /dev/null +++ b/services/Directory/FilterLists.Directory.Api/.editorconfig @@ -0,0 +1,4 @@ +# To learn more about .editorconfig see https://aka.ms/editorconfigdocs + +[*.cs] +dotnet_diagnostic.CS1591.severity = suggestion \ No newline at end of file diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/LanguagesController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/LanguagesController.cs index 679544f04..4f384a2dc 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/LanguagesController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/LanguagesController.cs @@ -18,6 +18,11 @@ public LanguagesController(IMemoryCache cache, IMediator mediator) : base(cache) _mediator = mediator; } + /// + /// Gets the languages targeted by FilterLists. + /// + /// The cancellation token. + /// The languages targeted by FilterLists. [HttpGet] [ProducesResponseType(typeof(IEnumerable), StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/LicensesController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/LicensesController.cs index 043440ce3..3c7779919 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/LicensesController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/LicensesController.cs @@ -18,6 +18,11 @@ public LicensesController(IMemoryCache cache, IMediator mediator) : base(cache) _mediator = mediator; } + /// + /// Gets the licenses applied to FilterLists. + /// + /// The cancellation token. + /// The licenses applied to FilterLists. [HttpGet] [ProducesResponseType(typeof(IEnumerable), StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/ListsController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/ListsController.cs index 8911f2a9a..f9f7138d4 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/ListsController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/ListsController.cs @@ -19,6 +19,11 @@ public ListsController(IMemoryCache cache, IMediator mediator) : base(cache) _mediator = mediator; } + /// + /// Gets the FilterLists.. + /// + /// The cancellation token. + /// The FilterLists. [HttpGet] [ProducesResponseType(typeof(IEnumerable), StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] @@ -27,13 +32,18 @@ public async Task Get(CancellationToken cancellationToken) return await CacheGetOrCreateAsync(() => _mediator.Send(new GetLists.Query(), cancellationToken)); } + /// + /// Gets the details of the FilterList. + /// + /// The identifier of the FilterList. + /// The cancellation token. + /// The details of the FilterList. [HttpGet("{id}")] [ProducesResponseType(typeof(ListDetailsVm), StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] public async Task GetDetails(int id, CancellationToken cancellationToken) { - return await CacheGetOrCreateAsync(() => _mediator.Send(new GetListDetails.Query(id), cancellationToken), - id); + return await CacheGetOrCreateAsync(() => _mediator.Send(new GetListDetails.Query(id), cancellationToken), id); } } } diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/MaintainersController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/MaintainersController.cs index 76318a6fb..1fd340904 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/MaintainersController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/MaintainersController.cs @@ -18,6 +18,11 @@ public MaintainersController(IMemoryCache cache, IMediator mediator) : base(cach _mediator = mediator; } + /// + /// Gets the maintainers of FilterLists. + /// + /// The cancellation token. + /// The maintainers of FilterLists. [HttpGet] [ProducesResponseType(typeof(IEnumerable), StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/SoftwareController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/SoftwareController.cs index 3ff8432df..c3f7cf0e3 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/SoftwareController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/SoftwareController.cs @@ -18,6 +18,11 @@ public SoftwareController(IMemoryCache cache, IMediator mediator) : base(cache) _mediator = mediator; } + /// + /// Gets the software that subscribes to FilterLists. + /// + /// The cancellation token. + /// The software that subscribes to FilterLists. [HttpGet] [ProducesResponseType(typeof(IEnumerable), StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/SyntaxesController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/SyntaxesController.cs index 237bb5655..052a91fd5 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/SyntaxesController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/SyntaxesController.cs @@ -18,6 +18,11 @@ public SyntaxesController(IMemoryCache cache, IMediator mediator) : base(cache) _mediator = mediator; } + /// + /// Gets the syntaxes of FilterLists. + /// + /// The cancellation token. + /// The syntaxes of FilterLists. [HttpGet] [ProducesResponseType(typeof(IEnumerable), StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/TagsController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/TagsController.cs index 9c6f84af4..2940d5895 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/TagsController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/TagsController.cs @@ -18,6 +18,11 @@ public TagsController(IMemoryCache cache, IMediator mediator) : base(cache) _mediator = mediator; } + /// + /// Gets the tags of FilterLists. + /// + /// The cancellation token. + /// The tags of FilterLists. [HttpGet] [ProducesResponseType(typeof(IEnumerable), StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] diff --git a/services/Directory/FilterLists.Directory.Api/FilterLists.Directory.Api.csproj b/services/Directory/FilterLists.Directory.Api/FilterLists.Directory.Api.csproj index 1d8ede3c4..7652e5aa1 100644 --- a/services/Directory/FilterLists.Directory.Api/FilterLists.Directory.Api.csproj +++ b/services/Directory/FilterLists.Directory.Api/FilterLists.Directory.Api.csproj @@ -4,6 +4,7 @@ netcoreapp3.1 latest enable + true true linux-musl-x64;win10-x64 diff --git a/services/Directory/FilterLists.Directory.Api/SwaggerExtensions.cs b/services/Directory/FilterLists.Directory.Api/SwaggerExtensions.cs index cbdb88413..7b63feb78 100644 --- a/services/Directory/FilterLists.Directory.Api/SwaggerExtensions.cs +++ b/services/Directory/FilterLists.Directory.Api/SwaggerExtensions.cs @@ -1,5 +1,7 @@ using System; using System.Collections.Generic; +using System.IO; +using System.Reflection; using Microsoft.AspNetCore.Builder; using Microsoft.Extensions.DependencyInjection; using Microsoft.OpenApi.Models; @@ -25,6 +27,10 @@ public static void AddSwaggerGen(this IServiceCollection services) Url = new Uri("https://github.com/collinbarrett/FilterLists/blob/master/LICENSE") } }); + + var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; + var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); + o.IncludeXmlComments(xmlPath); }); }