From df859318d58c92e8a4c5e3321e92ca9dff9bf78b Mon Sep 17 00:00:00 2001 From: "Collin M. Barrett" Date: Sat, 12 Sep 2020 14:06:19 -0500 Subject: [PATCH] =?UTF-8?q?feat(directory):=20=E2=9C=A8=20add=20explicit?= =?UTF-8?q?=20API=20response=20types=20for=20swagger=20ui?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../Controllers/LanguagesController.cs | 5 ++++- .../Controllers/LicensesController.cs | 5 ++++- .../Controllers/ListsController.cs | 6 +++++- .../Controllers/MaintainersController.cs | 5 ++++- .../Controllers/SoftwareController.cs | 5 ++++- .../Controllers/SyntaxesController.cs | 5 ++++- .../FilterLists.Directory.Api/Controllers/TagsController.cs | 5 ++++- services/Directory/FilterLists.Directory.Api/Startup.cs | 2 +- 8 files changed, 30 insertions(+), 8 deletions(-) diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/LanguagesController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/LanguagesController.cs index 4687d7317..aa19799f5 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/LanguagesController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/LanguagesController.cs @@ -1,4 +1,6 @@ -using System.Threading; +using System.Collections.Generic; +using System.Net; +using System.Threading; using System.Threading.Tasks; using FilterLists.Directory.Application.Queries; using MediatR; @@ -18,6 +20,7 @@ public LanguagesController(IMediator mediator) } [HttpGet] + [ProducesResponseType(typeof(IEnumerable), (int)HttpStatusCode.OK)] public async Task Get(CancellationToken cancellationToken) { return Ok(await _mediator.Send(new GetLanguages.Query(), cancellationToken)); diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/LicensesController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/LicensesController.cs index 37d319bf6..5eff378b4 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/LicensesController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/LicensesController.cs @@ -1,4 +1,6 @@ -using System.Threading; +using System.Collections.Generic; +using System.Net; +using System.Threading; using System.Threading.Tasks; using FilterLists.Directory.Application.Queries; using MediatR; @@ -18,6 +20,7 @@ public LicensesController(IMediator mediator) } [HttpGet] + [ProducesResponseType(typeof(IEnumerable), (int)HttpStatusCode.OK)] public async Task Get(CancellationToken cancellationToken) { return Ok(await _mediator.Send(new GetLicenses.Query(), cancellationToken)); diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/ListsController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/ListsController.cs index 18849f643..bab5fc1de 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/ListsController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/ListsController.cs @@ -1,4 +1,6 @@ -using System.Threading; +using System.Collections.Generic; +using System.Net; +using System.Threading; using System.Threading.Tasks; using FilterLists.Directory.Application.Queries; using MediatR; @@ -18,12 +20,14 @@ public ListsController(IMediator mediator) } [HttpGet] + [ProducesResponseType(typeof(IEnumerable), (int)HttpStatusCode.OK)] public async Task Get(CancellationToken cancellationToken) { return Ok(await _mediator.Send(new GetLists.Query(), cancellationToken)); } [HttpGet("{id}")] + [ProducesResponseType(typeof(GetListDetails.ListViewModel), (int)HttpStatusCode.OK)] public async Task GetDetails(int id, CancellationToken cancellationToken) { return Ok(await _mediator.Send(new GetListDetails.Query(id), cancellationToken)); diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/MaintainersController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/MaintainersController.cs index d67a84e3e..db993afee 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/MaintainersController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/MaintainersController.cs @@ -1,4 +1,6 @@ -using System.Threading; +using System.Collections.Generic; +using System.Net; +using System.Threading; using System.Threading.Tasks; using FilterLists.Directory.Application.Queries; using MediatR; @@ -18,6 +20,7 @@ public MaintainersController(IMediator mediator) } [HttpGet] + [ProducesResponseType(typeof(IEnumerable), (int)HttpStatusCode.OK)] public async Task Get(CancellationToken cancellationToken) { return Ok(await _mediator.Send(new GetMaintainers.Query(), cancellationToken)); diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/SoftwareController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/SoftwareController.cs index ce19cf253..65a54dc16 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/SoftwareController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/SoftwareController.cs @@ -1,4 +1,6 @@ -using System.Threading; +using System.Collections.Generic; +using System.Net; +using System.Threading; using System.Threading.Tasks; using FilterLists.Directory.Application.Queries; using MediatR; @@ -18,6 +20,7 @@ public SoftwareController(IMediator mediator) } [HttpGet] + [ProducesResponseType(typeof(IEnumerable), (int)HttpStatusCode.OK)] public async Task Get(CancellationToken cancellationToken) { return Ok(await _mediator.Send(new GetSoftware.Query(), cancellationToken)); diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/SyntaxesController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/SyntaxesController.cs index d4ed1412a..d9fcf3ae9 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/SyntaxesController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/SyntaxesController.cs @@ -1,4 +1,6 @@ -using System.Threading; +using System.Collections.Generic; +using System.Net; +using System.Threading; using System.Threading.Tasks; using FilterLists.Directory.Application.Queries; using MediatR; @@ -18,6 +20,7 @@ public SyntaxesController(IMediator mediator) } [HttpGet] + [ProducesResponseType(typeof(IEnumerable), (int)HttpStatusCode.OK)] public async Task Get(CancellationToken cancellationToken) { return Ok(await _mediator.Send(new GetSyntaxes.Query(), cancellationToken)); diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/TagsController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/TagsController.cs index b01ddce62..7cdda63d4 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/TagsController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/TagsController.cs @@ -1,4 +1,6 @@ -using System.Threading; +using System.Collections.Generic; +using System.Net; +using System.Threading; using System.Threading.Tasks; using FilterLists.Directory.Application.Queries; using MediatR; @@ -18,6 +20,7 @@ public TagsController(IMediator mediator) } [HttpGet] + [ProducesResponseType(typeof(IEnumerable), (int)HttpStatusCode.OK)] public async Task Get(CancellationToken cancellationToken) { return Ok(await _mediator.Send(new GetTags.Query(), cancellationToken)); diff --git a/services/Directory/FilterLists.Directory.Api/Startup.cs b/services/Directory/FilterLists.Directory.Api/Startup.cs index 5ffff8443..26aa4eccb 100644 --- a/services/Directory/FilterLists.Directory.Api/Startup.cs +++ b/services/Directory/FilterLists.Directory.Api/Startup.cs @@ -21,7 +21,7 @@ public void ConfigureServices(IServiceCollection services) services.AddRouting(o => o.LowercaseUrls = true); services.AddControllers() .AddJsonOptions(o => o.JsonSerializerOptions.IgnoreNullValues = true); - services.AddSwaggerGen(); + services.AddSwaggerGen(o => o.CustomSchemaIds(type => type.ToString())); services.AddApplicationServices(Configuration); }