Skip to content

Commit da7a7bc

Browse files
hhvrchhvrc
committed
Remove ProducesProblem and ProducesDoc
1 parent cab3652 commit da7a7bc

Some content is hidden

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

56 files changed

+200
-192
lines changed

‎API/Controller/Account/Authenticated/ChangeEmail.cs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
using Microsoft.AspNetCore.Mvc;
1+
using System.Net.Mime;
2+
using Microsoft.AspNetCore.Mvc;
23
using OpenShock.API.Models.Requests;
34
using OpenShock.Common.Errors;
45
using OpenShock.Common.Models;
@@ -16,7 +17,7 @@ public sealed partial class AuthenticatedAccountController
1617
/// <returns></returns>
1718
/// <exception cref="Exception"></exception>
1819
[HttpPost("email")]
19-
[ProducesResponseType<BaseResponse<object>>(StatusCodes.Status200OK)]
20+
[ProducesResponseType<BaseResponse<object>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
2021
public Task<IActionResult> ChangeEmail(ChangeEmailRequest data)
2122
{
2223
throw new NotImplementedException();

‎API/Controller/Account/Authenticated/ChangeUsername.cs‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
using System.Net;
2+
using System.Net.Mime;
23
using Microsoft.AspNetCore.Mvc;
34
using OpenShock.API.Models.Requests;
45
using OpenShock.Common.Errors;
@@ -17,9 +18,9 @@ public sealed partial class AuthenticatedAccountController
1718
/// <exception cref="Exception"></exception>
1819
[HttpPost("username")]
1920
[ProducesResponseType(StatusCodes.Status200OK)]
20-
[ProducesProblem(HttpStatusCode.Conflict, "UsernameTaken")]
21-
[ProducesProblem(HttpStatusCode.BadRequest, "UsernameInvalid")]
22-
[ProducesProblem(HttpStatusCode.Forbidden, "UsernameRecentlyChanged")]
21+
[ProducesResponseType<OpenShockProblem>(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] // UsernameTaken
22+
[ProducesResponseType<OpenShockProblem>(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // UsernameInvalid
23+
[ProducesResponseType<OpenShockProblem>(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] // UsernameRecentlyChanged
2324
public async Task<IActionResult> ChangeUsername(ChangeUsernameRequest data)
2425
{
2526
var result = await _accountService.ChangeUsername(CurrentUser.DbUser.Id, data.Username,

‎API/Controller/Account/CheckUsername.cs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
using System.Diagnostics.CodeAnalysis;
2+
using System.Net.Mime;
23
using Microsoft.AspNetCore.Mvc;
34
using OpenShock.API.Models.Requests;
45
using OpenShock.Common.Problems;
@@ -15,7 +16,7 @@ public sealed partial class AccountController
1516
/// <param name="cancellationToken"></param>
1617
/// <returns></returns>
1718
[HttpPost("username/check")]
18-
[ProducesResponseType<UsernameCheckResponse>(StatusCodes.Status200OK)]
19+
[ProducesResponseType<UsernameCheckResponse>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
1920
public async Task<IActionResult> CheckUsername(ChangeUsernameRequest data, CancellationToken cancellationToken)
2021
{
2122
var availability = await _accountService.CheckUsernameAvailability(data.Username, cancellationToken);

‎API/Controller/Account/Login.cs‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
using Microsoft.AspNetCore.Mvc;
22
using OpenShock.API.Models.Requests;
33
using System.Net;
4+
using System.Net.Mime;
45
using Asp.Versioning;
56
using OpenShock.API.Services.Account;
67
using OpenShock.Common;
@@ -20,9 +21,9 @@ public sealed partial class AccountController
2021
/// <response code="200">User successfully logged in</response>
2122
/// <response code="401">Invalid username or password</response>
2223
[HttpPost("login")]
23-
[ProducesResponseType<BaseResponse<object>>(StatusCodes.Status200OK)]
24-
[ProducesProblem(HttpStatusCode.Unauthorized, "InvalidCredentials")]
25-
[ProducesProblem(HttpStatusCode.Forbidden, "InvalidDomain")]
24+
[ProducesResponseType<BaseResponse<object>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
25+
[ProducesResponseType<OpenShockProblem>(StatusCodes.Status401Unauthorized, MediaTypeNames.Application.ProblemJson)] // InvalidCredentials
26+
[ProducesResponseType<OpenShockProblem>(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] // InvalidDomain
2627
[MapToApiVersion("1")]
2728
public async Task<IActionResult> Login(
2829
[FromBody] Login body,

‎API/Controller/Account/LoginV2.cs‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
using Microsoft.AspNetCore.Mvc;
22
using OpenShock.API.Models.Requests;
33
using System.Net;
4+
using System.Net.Mime;
45
using Asp.Versioning;
56
using OpenShock.API.Services.Account;
67
using OpenShock.Common;
@@ -21,9 +22,9 @@ public sealed partial class AccountController
2122
/// <response code="200">User successfully logged in</response>
2223
/// <response code="401">Invalid username or password</response>
2324
[HttpPost("login")]
24-
[ProducesResponseType<BaseResponse<object>>(StatusCodes.Status200OK)]
25-
[ProducesProblem(HttpStatusCode.Unauthorized, "InvalidCredentials")]
26-
[ProducesProblem(HttpStatusCode.Forbidden, "InvalidDomain")]
25+
[ProducesResponseType<BaseResponse<object>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
26+
[ProducesResponseType<OpenShockProblem>(StatusCodes.Status401Unauthorized, MediaTypeNames.Application.ProblemJson)] // InvalidCredentials
27+
[ProducesResponseType<OpenShockProblem>(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] // InvalidDomain
2728
[MapToApiVersion("2")]
2829
public async Task<IActionResult> LoginV2(
2930
[FromBody] LoginV2 body,

‎API/Controller/Account/PasswordResetCheckValid.cs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
using Microsoft.AspNetCore.Mvc;
22
using System.Net;
3+
using System.Net.Mime;
34
using Asp.Versioning;
45
using OpenShock.API.Services.Account;
56
using OpenShock.Common.Errors;
@@ -19,8 +20,8 @@ public sealed partial class AccountController
1920
/// <response code="200">Valid password reset process</response>
2021
/// <response code="404">Password reset process not found</response>
2122
[HttpHead("recover/{passwordResetId}/{secret}")]
22-
[ProducesResponseType<BaseResponse<object>>(StatusCodes.Status200OK)]
23-
[ProducesProblem(HttpStatusCode.NotFound, "PasswordResetNotFound")]
23+
[ProducesResponseType<BaseResponse<object>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
24+
[ProducesResponseType<OpenShockProblem>(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // PasswordResetNotFound
2425
[MapToApiVersion("1")]
2526
public async Task<IActionResult> PasswordResetCheckValid([FromRoute] Guid passwordResetId, [FromRoute] string secret, CancellationToken cancellationToken)
2627
{

‎API/Controller/Account/PasswordResetComplete.cs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
using Microsoft.AspNetCore.Mvc;
22
using System.Net;
3+
using System.Net.Mime;
34
using Asp.Versioning;
45
using OpenShock.API.Services.Account;
56
using OpenShock.Common.Errors;
@@ -19,8 +20,8 @@ public sealed partial class AccountController
1920
/// <response code="200">Password successfully changed</response>
2021
/// <response code="404">Password reset process not found</response>
2122
[HttpPost("recover/{passwordResetId}/{secret}")]
22-
[ProducesResponseType<BaseResponse<object>>(StatusCodes.Status200OK)]
23-
[ProducesProblem(HttpStatusCode.NotFound, "PasswordResetNotFound")]
23+
[ProducesResponseType<BaseResponse<object>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
24+
[ProducesResponseType<OpenShockProblem>(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // PasswordResetNotFound
2425
[MapToApiVersion("1")]
2526
public async Task<IActionResult> PasswordResetComplete([FromRoute] Guid passwordResetId,
2627
[FromRoute] string secret, [FromBody] PasswordResetProcessData body)

‎API/Controller/Account/PasswordResetInitiate.cs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
using Microsoft.AspNetCore.Mvc;
1+
using System.Net.Mime;
2+
using Microsoft.AspNetCore.Mvc;
23
using OpenShock.Common.Models;
34
using Asp.Versioning;
45
using OpenShock.API.Services.Account;
@@ -13,7 +14,7 @@ public sealed partial class AccountController
1314
/// </summary>
1415
/// <response code="200">Password reset email sent if the email is associated to an registered account</response>
1516
[HttpPost("reset")]
16-
[ProducesResponseType<BaseResponse<object>>(StatusCodes.Status200OK)]
17+
[ProducesResponseType<BaseResponse<object>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
1718
[MapToApiVersion("1")]
1819
public async Task<BaseResponse<object>> PasswordResetInitiate([FromBody] ResetRequest body)
1920
{

‎API/Controller/Account/Signup.cs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
using Microsoft.AspNetCore.Mvc;
22
using OpenShock.API.Models.Requests;
33
using System.Net;
4+
using System.Net.Mime;
45
using Asp.Versioning;
56
using OpenShock.API.Services.Account;
67
using OpenShock.Common.Errors;
@@ -18,8 +19,8 @@ public sealed partial class AccountController
1819
/// <response code="200">User successfully signed up</response>
1920
/// <response code="409">Username or email already exists</response>
2021
[HttpPost("signup")]
21-
[ProducesResponseType<BaseResponse<object>>(StatusCodes.Status200OK)]
22-
[ProducesProblem(HttpStatusCode.Conflict, "EmailOrUsernameAlreadyExists")]
22+
[ProducesResponseType<BaseResponse<object>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
23+
[ProducesResponseType<OpenShockProblem>(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] // EmailOrUsernameAlreadyExists
2324
[MapToApiVersion("1")]
2425
public async Task<IActionResult> SignUp([FromBody] SignUp body)
2526
{

‎API/Controller/Account/SignupV2.cs‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
using Microsoft.AspNetCore.Mvc;
22
using OpenShock.API.Models.Requests;
33
using System.Net;
4+
using System.Net.Mime;
45
using Asp.Versioning;
56
using OpenShock.API.Services.Account;
67
using OpenShock.Common.Errors;
@@ -23,9 +24,9 @@ public sealed partial class AccountController
2324
/// <response code="200">User successfully signed up</response>
2425
/// <response code="400">Username or email already exists</response>
2526
[HttpPost("signup")]
26-
[ProducesResponseType<BaseResponse<object>>(StatusCodes.Status200OK)]
27-
[ProducesProblem(HttpStatusCode.Conflict, "EmailOrUsernameAlreadyExists")]
28-
[ProducesProblem(HttpStatusCode.Forbidden, "InvalidTurnstileResponse")]
27+
[ProducesResponseType<BaseResponse<object>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
28+
[ProducesResponseType<OpenShockProblem>(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] // EmailOrUsernameAlreadyExists
29+
[ProducesResponseType<OpenShockProblem>(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] // InvalidTurnstileResponse
2930
[MapToApiVersion("2")]
3031
public async Task<IActionResult> SignUpV2(
3132
[FromBody] SignUpV2 body,

0 commit comments

Comments
 (0)