Skip to content

Minor swagger updates #52

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

Merged
merged 2 commits into from
Apr 14, 2021
Merged

Minor swagger updates #52

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
75c83ff
Minor swagger updates
StuartFerguson Apr 14, 2021
fd38421
Merge branch 'master' into documentation/#47_swaggerpages
StuartFerguson Apr 14, 2021
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
6 changes: 5 additions & 1 deletion MessagingService.DataTransferObjects/MessagingService.DataTransferObjects.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFrameworks>net5.0;netstandard2.0</TargetFrameworks>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(TargetFramework)|$(Platform)'=='Debug|net5.0|AnyCPU'">
<DocumentationFile>D:\Projects\StuartFerguson\Messaging\MessagingService.DataTransferObjects\MessagingService.DataTransferObjects.xml</DocumentationFile>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
</ItemGroup>
Expand Down
125 changes: 125 additions & 0 deletions MessagingService.DataTransferObjects/MessagingService.DataTransferObjects.xml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions MessagingService/Controllers/DomainEventController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
[Route(DomainEventController.ControllerRoute)]
[ApiController]
[ExcludeFromCodeCoverage]
[ApiExplorerSettings(IgnoreApi = true)]
public class DomainEventController : ControllerBase
{
#region Fields
Expand Down
10 changes: 4 additions & 6 deletions MessagingService/Controllers/EmailController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,19 +49,17 @@ public EmailController(IMediator mediator)
#endregion

#region Methods

/// <summary>
/// Posts the email.
/// Sends the email.
/// </summary>
/// <param name="sendEmailRequest">The send email request.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns></returns>
[HttpPost]
[Route("")]
[SwaggerResponse(201, "Created", typeof(SendEmailResponseDTO))]
[SwaggerResponseExample(201, typeof(SendEmailResponseExample))]

public async Task<IActionResult> PostEmail([FromBody] SendEmailRequestDTO sendEmailRequest,
[ProducesResponseType(typeof(SendEmailResponseDTO), 201)]
public async Task<IActionResult> SendEmail([FromBody] SendEmailRequestDTO sendEmailRequest,
CancellationToken cancellationToken)
{
// Reject password tokens
Expand Down
9 changes: 4 additions & 5 deletions MessagingService/Controllers/SMSController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,17 @@ public SMSController(IMediator mediator)
#endregion

#region Methods

/// <summary>
/// Posts the sms.
/// Sends the SMS.
/// </summary>
/// <param name="sendSMSRequest">The send SMS request.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns></returns>
[HttpPost]
[Route("")]
[SwaggerResponse(201, "Created", typeof(SendSMSResponse))]
[SwaggerResponseExample(201, typeof(SendSMSResponseExample))]
public async Task<IActionResult> PostSMS([FromBody] SendSMSRequest sendSMSRequest,
[ProducesResponseType(typeof(SendSMSResponse), 201)]
public async Task<IActionResult> SendSMS([FromBody] SendSMSRequest sendSMSRequest,
CancellationToken cancellationToken)
{
// Reject password tokens
Expand Down
4 changes: 4 additions & 0 deletions MessagingService/MessagingService.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
<DockerDefaultTargetOS>Linux</DockerDefaultTargetOS>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<DocumentationFile>D:\Projects\StuartFerguson\Messaging\MessagingService\MessagingService.xml</DocumentationFile>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="AspNetCore.HealthChecks.UI.Client" Version="5.0.1" />
<PackageReference Include="AspNetCore.HealthChecks.Uris" Version="5.0.1" />
Expand Down
Loading