diff --git a/API.IntegrationTests/Tests/OpenApiDocumentTests.cs b/API.IntegrationTests/Tests/OpenApiDocumentTests.cs new file mode 100644 index 000000000..e1129a239 --- /dev/null +++ b/API.IntegrationTests/Tests/OpenApiDocumentTests.cs @@ -0,0 +1,27 @@ +using System.Net; +using System.Text.Json; + +namespace OpenShock.API.IntegrationTests.Tests; + +public sealed class OpenApiDocumentTests +{ + [ClassDataSource(Shared = SharedType.PerTestSession)] + public required WebApplicationFactory WebApplicationFactory { get; init; } + + [Test] + public async Task GetOpenApiDocument_ServesSingleDocumentWithEveryVersion() + { + using var client = WebApplicationFactory.CreateClient(); + + var response = await client.GetAsync("/openapi.json"); + + await Assert.That(response.StatusCode).IsEqualTo(HttpStatusCode.OK); + await Assert.That(response.Content.Headers.ContentType?.MediaType).IsEqualTo("application/json"); + + using var doc = JsonDocument.Parse(await response.Content.ReadAsStringAsync()); + var paths = doc.RootElement.GetProperty("paths").EnumerateObject().Select(p => p.Name).ToArray(); + + await Assert.That(paths).Contains("/1/account"); + await Assert.That(paths).Contains("/2/account/login"); + } +} diff --git a/API/API.csproj b/API/API.csproj index 4a5a13ddd..eedbc1dad 100644 --- a/API/API.csproj +++ b/API/API.csproj @@ -12,6 +12,8 @@ + + diff --git a/API/Controller/Account/Activate.cs b/API/Controller/Account/Activate.cs index 94c9cf41e..e37090bfd 100644 --- a/API/Controller/Account/Activate.cs +++ b/API/Controller/Account/Activate.cs @@ -1,6 +1,6 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Internal.Common.Problems; @@ -11,11 +11,10 @@ public sealed partial class AccountController /// /// Activate account /// - /// [HttpPost("activate")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] - [MapToApiVersion("1")] public async Task Activate([FromQuery(Name = "token")] string token, CancellationToken cancellationToken) { bool ok = await _accountService.TryActivateAccountAsync(token, cancellationToken); diff --git a/API/Controller/Account/Authenticated/ChangeEmail.cs b/API/Controller/Account/Authenticated/ChangeEmail.cs index 21a8dda27..42b31a7de 100644 --- a/API/Controller/Account/Authenticated/ChangeEmail.cs +++ b/API/Controller/Account/Authenticated/ChangeEmail.cs @@ -3,6 +3,7 @@ using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Requests; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Utils; using OpenShock.Internal.Common.Problems; @@ -19,6 +20,7 @@ public sealed partial class AuthenticatedAccountController /// /// [HttpPost("email-change")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // EmailChangeUnchanged diff --git a/API/Controller/Account/Authenticated/ChangePassword.cs b/API/Controller/Account/Authenticated/ChangePassword.cs index 6ac27e218..8d562b533 100644 --- a/API/Controller/Account/Authenticated/ChangePassword.cs +++ b/API/Controller/Account/Authenticated/ChangePassword.cs @@ -3,6 +3,7 @@ using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Requests; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Utils; using OpenShock.Internal.Common.Problems; @@ -17,9 +18,9 @@ public sealed partial class AuthenticatedAccountController /// /// /// - /// /// [HttpPost("password")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] // PasswordChangeInvalidPassword diff --git a/API/Controller/Account/Authenticated/ChangeUsername.cs b/API/Controller/Account/Authenticated/ChangeUsername.cs index 580339b52..18e35219e 100644 --- a/API/Controller/Account/Authenticated/ChangeUsername.cs +++ b/API/Controller/Account/Authenticated/ChangeUsername.cs @@ -3,6 +3,7 @@ using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Requests; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Validation; @@ -18,9 +19,9 @@ public sealed partial class AuthenticatedAccountController /// /// /// - /// /// [HttpPost("username")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] // UsernameTaken diff --git a/API/Controller/Account/Authenticated/Deactivate.cs b/API/Controller/Account/Authenticated/Deactivate.cs index 4a7a8a62b..3feee0a3c 100644 --- a/API/Controller/Account/Authenticated/Deactivate.cs +++ b/API/Controller/Account/Authenticated/Deactivate.cs @@ -1,6 +1,7 @@ using System.Diagnostics; using System.Net.Mime; using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Internal.Common.Problems; using AccountSvc = OpenShock.API.Services.Account; @@ -15,6 +16,7 @@ public sealed partial class AuthenticatedAccountController /// /// Done. [HttpDelete] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status204NoContent)] [ProducesResponseType(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] // CannotDeactivatePrivledgedAccount public async Task Deactivate(CancellationToken cancellationToken) diff --git a/API/Controller/Account/Authenticated/GetAuditLog.cs b/API/Controller/Account/Authenticated/GetAuditLog.cs index 86fbd6eec..eb9d8251d 100644 --- a/API/Controller/Account/Authenticated/GetAuditLog.cs +++ b/API/Controller/Account/Authenticated/GetAuditLog.cs @@ -1,6 +1,7 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Services.Audit; using OpenShock.Common.Utils; @@ -18,6 +19,7 @@ public sealed partial class AuthenticatedAccountController /// /// A page of audit log entries. [HttpGet("audit-log")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task> GetAuditLog( [FromQuery] PaginationQuery pagination, diff --git a/API/Controller/Account/Authenticated/GetSelf.cs b/API/Controller/Account/Authenticated/GetSelf.cs index 774924987..31305e8bf 100644 --- a/API/Controller/Account/Authenticated/GetSelf.cs +++ b/API/Controller/Account/Authenticated/GetSelf.cs @@ -2,6 +2,7 @@ using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication; using OpenShock.Common.Extensions; using OpenShock.Common.OpenShockDb; @@ -15,6 +16,7 @@ public sealed partial class AuthenticatedAccountController /// /// The account information was successfully retrieved. [HttpGet] + [ApiVersion(1)] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.UserSessionApiTokenCombo)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public UserSelfResponse GetSelf() => new() diff --git a/API/Controller/Account/Authenticated/OAuthConnectionRemove.cs b/API/Controller/Account/Authenticated/OAuthConnectionRemove.cs index f1af6e51f..9796a6cfc 100644 --- a/API/Controller/Account/Authenticated/OAuthConnectionRemove.cs +++ b/API/Controller/Account/Authenticated/OAuthConnectionRemove.cs @@ -1,5 +1,6 @@ using Microsoft.AspNetCore.Mvc; using OpenShock.API.Services.OAuthConnection; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Account.Authenticated; @@ -14,6 +15,7 @@ public sealed partial class AuthenticatedAccountController /// Connection removed. /// No connection found for this provider. [HttpDelete("connections/{provider}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status204NoContent)] [ProducesResponseType(StatusCodes.Status404NotFound)] public async Task RemoveOAuthConnection([FromRoute] string provider, [FromServices] IOAuthConnectionService connectionService, CancellationToken cancellationToken) diff --git a/API/Controller/Account/Authenticated/OAuthConnectionsList.cs b/API/Controller/Account/Authenticated/OAuthConnectionsList.cs index 6bbad5864..82666c1b9 100644 --- a/API/Controller/Account/Authenticated/OAuthConnectionsList.cs +++ b/API/Controller/Account/Authenticated/OAuthConnectionsList.cs @@ -3,6 +3,7 @@ using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; using OpenShock.API.Services.OAuthConnection; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Account.Authenticated; @@ -14,6 +15,7 @@ public sealed partial class AuthenticatedAccountController /// Array of connections with provider key, external id, display name and link time. /// Returns the list of connections. [HttpGet("connections")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public IActionResult ListOAuthConnections([FromServices] IOAuthConnectionService connectionService, CancellationToken cancellationToken) { diff --git a/API/Controller/Account/Authenticated/_ApiController.cs b/API/Controller/Account/Authenticated/_ApiController.cs index 1b9553e88..9be085689 100644 --- a/API/Controller/Account/Authenticated/_ApiController.cs +++ b/API/Controller/Account/Authenticated/_ApiController.cs @@ -1,5 +1,4 @@ -using Asp.Versioning; -using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Services.Account; using OpenShock.Common.Authentication; @@ -12,7 +11,6 @@ namespace OpenShock.API.Controller.Account.Authenticated; /// [ApiController] [Tags("Account")] -[ApiVersion("1")] [Route("/{version:apiVersion}/account")] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.UserSessionCookie)] public sealed partial class AuthenticatedAccountController : AuthenticatedSessionControllerBase diff --git a/API/Controller/Account/CheckUsername.cs b/API/Controller/Account/CheckUsername.cs index 52c366de7..b96d47894 100644 --- a/API/Controller/Account/CheckUsername.cs +++ b/API/Controller/Account/CheckUsername.cs @@ -4,6 +4,7 @@ using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Requests; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Results; using OpenShock.Common.Validation; @@ -16,8 +17,8 @@ public sealed partial class AccountController /// /// /// - /// [HttpPost("username/check")] // High-volume endpoint, we don't want to rate limit this + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] public async Task CheckUsername([FromBody] ChangeUsernameRequest body, CancellationToken cancellationToken) { diff --git a/API/Controller/Account/Login.cs b/API/Controller/Account/Login.cs index 7503c3346..8f07a1d8e 100644 --- a/API/Controller/Account/Login.cs +++ b/API/Controller/Account/Login.cs @@ -1,5 +1,5 @@ -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; namespace OpenShock.API.Controller.Account; @@ -9,9 +9,9 @@ public sealed partial class AccountController /// /// Authenticate a user. Retired: use POST /2/account/login instead. /// - [HttpPost("login")] [Obsolete("Retired. Use POST /2/account/login instead.")] + [HttpPost("login")] + [ApiVersion(1)] [ApiExplorerSettings(IgnoreApi = true)] - [MapToApiVersion("1")] public IActionResult Login() => Problem(GoneError.EndpointRetired("POST /2/account/login")); } diff --git a/API/Controller/Account/LoginV2.cs b/API/Controller/Account/LoginV2.cs index 2c1cd4e04..0b1b80be8 100644 --- a/API/Controller/Account/LoginV2.cs +++ b/API/Controller/Account/LoginV2.cs @@ -1,5 +1,4 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.Errors; @@ -7,6 +6,7 @@ using OpenShock.API.Models.Response; using OpenShock.API.Services.Account; using OpenShock.API.Services.Turnstile; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Services.AutomationTokens; @@ -23,12 +23,12 @@ public sealed partial class AccountController /// User successfully logged in /// Invalid username or password [HttpPost("login")] + [ApiVersion(2)] [EnableRateLimiting("auth")] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status401Unauthorized, MediaTypeNames.Application.ProblemJson)] // InvalidCredentials [ProducesResponseType(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] // InvalidDomain, AutomationTokenNotAllowedForAccount - [MapToApiVersion("2")] public async Task LoginV2( [FromBody] LoginV2 body, [FromServices] ICloudflareTurnstileService turnstileService, diff --git a/API/Controller/Account/Logout.cs b/API/Controller/Account/Logout.cs index 922ee484d..2fe49ce3e 100644 --- a/API/Controller/Account/Logout.cs +++ b/API/Controller/Account/Logout.cs @@ -1,5 +1,5 @@ -using Asp.Versioning; -using Microsoft.AspNetCore.Mvc; +using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Extensions; using OpenShock.Common.Services.Session; @@ -8,8 +8,8 @@ namespace OpenShock.API.Controller.Account; public sealed partial class AccountController { [HttpPost("logout")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] - [MapToApiVersion("1")] public async Task Logout([FromServices] ISessionService sessionService) { // Remove session if valid diff --git a/API/Controller/Account/PasswordResetCheckValid.cs b/API/Controller/Account/PasswordResetCheckValid.cs index 3cf873cc2..0820cd33e 100644 --- a/API/Controller/Account/PasswordResetCheckValid.cs +++ b/API/Controller/Account/PasswordResetCheckValid.cs @@ -1,9 +1,9 @@ using System.Diagnostics; using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Models; using OpenShock.Internal.Common.Problems; @@ -20,8 +20,8 @@ public sealed partial class AccountController /// The secret of the password reset [Obsolete("Retired. Use GET /1/account/password-reset/{passwordResetId}/{secret} instead.")] [HttpHead("recover/{passwordResetId}/{secret}")] + [ApiVersion(1)] [ApiExplorerSettings(IgnoreApi = true)] - [MapToApiVersion("1")] public IActionResult PasswordResetCheckValidLegacy([FromRoute] Guid passwordResetId, [FromRoute] string secret) => Problem(GoneError.EndpointRetired("GET /1/account/password-reset/{passwordResetId}/{secret}")); @@ -34,10 +34,10 @@ public IActionResult PasswordResetCheckValidLegacy([FromRoute] Guid passwordRese /// Valid password reset process /// Password reset process not found [HttpGet("password-reset/{passwordResetId}/{secret}")] + [ApiVersion(1)] [EnableRateLimiting("auth")] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // PasswordResetNotFound - [MapToApiVersion("1")] public async Task PasswordResetCheckValid([FromRoute] Guid passwordResetId, [FromRoute] string secret, CancellationToken cancellationToken) { var passwordResetExists = await _accountService.CheckPasswordResetExistsAsync(passwordResetId, secret, cancellationToken); diff --git a/API/Controller/Account/PasswordResetComplete.cs b/API/Controller/Account/PasswordResetComplete.cs index 199bbabf8..158378fdb 100644 --- a/API/Controller/Account/PasswordResetComplete.cs +++ b/API/Controller/Account/PasswordResetComplete.cs @@ -1,9 +1,9 @@ using System.Diagnostics; using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Models; using OpenShock.Internal.Common.Problems; @@ -20,8 +20,8 @@ public sealed partial class AccountController /// The secret of the password reset [Obsolete("Retired. Use POST /1/account/password-reset/{passwordResetId}/{secret}/complete instead.")] [HttpPost("recover/{passwordResetId}/{secret}")] + [ApiVersion(1)] [ApiExplorerSettings(IgnoreApi = true)] - [MapToApiVersion("1")] public IActionResult PasswordResetCompleteLegacy([FromRoute] Guid passwordResetId, [FromRoute] string secret) => Problem(GoneError.EndpointRetired("POST /1/account/password-reset/{passwordResetId}/{secret}/complete")); @@ -35,11 +35,11 @@ public IActionResult PasswordResetCompleteLegacy([FromRoute] Guid passwordResetI /// Password successfully changed /// Password reset process not found [HttpPost("password-reset/{passwordResetId}/{secret}/complete")] + [ApiVersion(1)] [EnableRateLimiting("auth")] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // PasswordResetNotFound - [MapToApiVersion("1")] public async Task PasswordResetComplete([FromRoute] Guid passwordResetId, [FromRoute] string secret, [FromBody] PasswordResetProcessData body, CancellationToken cancellationToken) diff --git a/API/Controller/Account/PasswordResetInitiate.cs b/API/Controller/Account/PasswordResetInitiate.cs index 53a1abe17..84a1e9cb3 100644 --- a/API/Controller/Account/PasswordResetInitiate.cs +++ b/API/Controller/Account/PasswordResetInitiate.cs @@ -1,5 +1,5 @@ -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; namespace OpenShock.API.Controller.Account; @@ -9,9 +9,9 @@ public sealed partial class AccountController /// /// Initiate a password reset. Retired: use POST /2/account/password-reset instead. /// - [HttpPost("reset")] [Obsolete("Retired. Use POST /2/account/password-reset instead.")] + [HttpPost("reset")] + [ApiVersion(1)] [ApiExplorerSettings(IgnoreApi = true)] - [MapToApiVersion("1")] public IActionResult PasswordResetInitiate() => Problem(GoneError.EndpointRetired("POST /2/account/password-reset")); } diff --git a/API/Controller/Account/PasswordResetInitiateV2.cs b/API/Controller/Account/PasswordResetInitiateV2.cs index 845f05f90..560805bcf 100644 --- a/API/Controller/Account/PasswordResetInitiateV2.cs +++ b/API/Controller/Account/PasswordResetInitiateV2.cs @@ -1,9 +1,9 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.Models.Requests; using OpenShock.API.Services.Turnstile; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Services.AutomationTokens; @@ -18,8 +18,8 @@ public sealed partial class AccountController /// [Obsolete("Retired. Use POST /2/account/password-reset instead.")] [HttpPost("reset-password")] + [ApiVersion(2)] [ApiExplorerSettings(IgnoreApi = true)] - [MapToApiVersion("2")] public IActionResult PasswordResetInitiateV2Legacy() => Problem(GoneError.EndpointRetired("POST /2/account/password-reset")); /// @@ -27,11 +27,11 @@ public sealed partial class AccountController /// /// Password reset email sent if the email is associated to an registered account [HttpPost("password-reset")] + [ApiVersion(2)] [EnableRateLimiting("auth")] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] - [MapToApiVersion("2")] public async Task PasswordResetInitiateV2([FromBody] PasswordResetRequestV2 body, [FromServices] ICloudflareTurnstileService turnstileService, [FromServices] IAutomationTokenService automationTokens, CancellationToken cancellationToken) { var turnstileError = await VerifyTurnstileAsync(turnstileService, body.TurnstileResponse, cancellationToken); diff --git a/API/Controller/Account/ResendActivation.cs b/API/Controller/Account/ResendActivation.cs index 98216202c..9054b0003 100644 --- a/API/Controller/Account/ResendActivation.cs +++ b/API/Controller/Account/ResendActivation.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication; using OpenShock.Common.Errors; using OpenShock.Internal.Common.Problems; @@ -23,8 +23,8 @@ public sealed partial class AccountController /// No pending activation for this browser (missing/expired cookie, or already activated) /// An activation email was sent too recently [HttpPost("activate/resend")] + [ApiVersion(1)] [EnableRateLimiting("auth")] - [MapToApiVersion("1")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // AccountActivationResendUnavailable [ProducesResponseType(StatusCodes.Status429TooManyRequests, MediaTypeNames.Application.ProblemJson)] // AccountActivationResendTooMany diff --git a/API/Controller/Account/Signup.cs b/API/Controller/Account/Signup.cs index 109f3142f..4a8c31e5c 100644 --- a/API/Controller/Account/Signup.cs +++ b/API/Controller/Account/Signup.cs @@ -1,5 +1,5 @@ -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; namespace OpenShock.API.Controller.Account; @@ -9,9 +9,9 @@ public sealed partial class AccountController /// /// Signs up a new user. Retired: use POST /2/account/signup instead. /// - [HttpPost("signup")] [Obsolete("Retired. Use POST /2/account/signup instead.")] + [HttpPost("signup")] + [ApiVersion(1)] [ApiExplorerSettings(IgnoreApi = true)] - [MapToApiVersion("1")] public IActionResult SignUp() => Problem(GoneError.EndpointRetired("POST /2/account/signup")); } diff --git a/API/Controller/Account/SignupV2.cs b/API/Controller/Account/SignupV2.cs index cf98aee40..8871bb453 100644 --- a/API/Controller/Account/SignupV2.cs +++ b/API/Controller/Account/SignupV2.cs @@ -1,10 +1,10 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.Models.Requests; using OpenShock.API.Services.Account; using OpenShock.API.Services.Turnstile; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication; using OpenShock.Common.Errors; using OpenShock.Common.OpenShockDb; @@ -25,12 +25,12 @@ public sealed partial class AccountController /// User successfully signed up /// Username or email already exists [HttpPost("signup")] + [ApiVersion(2)] [EnableRateLimiting("auth")] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] // EmailOrUsernameAlreadyExists [ProducesResponseType(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] // RegistrationDisabled or InvalidTurnstileResponse - [MapToApiVersion("2")] public async Task SignUpV2( [FromBody] SignUpV2 body, [FromServices] ICloudflareTurnstileService turnstileService, diff --git a/API/Controller/Account/VerifyEmail.cs b/API/Controller/Account/VerifyEmail.cs index b5cebda67..0e5ee0ea1 100644 --- a/API/Controller/Account/VerifyEmail.cs +++ b/API/Controller/Account/VerifyEmail.cs @@ -1,8 +1,8 @@ using System.Diagnostics; using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Internal.Common.Problems; using Results = OpenShock.Common.Results; @@ -18,10 +18,10 @@ public sealed partial class AccountController /// Token is invalid, already used, or the request has expired /// The new email address was claimed by another account before verification completed [HttpPost("email-change/verify")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] - [MapToApiVersion("1")] public Task EmailVerify([FromQuery(Name = "token")] string token, CancellationToken cancellationToken) => VerifyPendingEmailChange(token, cancellationToken); @@ -33,10 +33,10 @@ public Task EmailVerify([FromQuery(Name = "token")] string token, /// The new email address was claimed by another account before verification completed [Obsolete("Use POST /email-change/verify instead.")] [HttpPost("verify-email")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] - [MapToApiVersion("1")] public Task EmailVerifyLegacy([FromQuery(Name = "token")] string token, CancellationToken cancellationToken) => VerifyPendingEmailChange(token, cancellationToken); diff --git a/API/Controller/Account/_ApiController.cs b/API/Controller/Account/_ApiController.cs index 80640e582..0438e6bfa 100644 --- a/API/Controller/Account/_ApiController.cs +++ b/API/Controller/Account/_ApiController.cs @@ -1,25 +1,23 @@ -using Asp.Versioning; -using Microsoft.AspNetCore.Mvc; -using OpenShock.API.Services.Account; -using OpenShock.Common; - -namespace OpenShock.API.Controller.Account; - -/// -/// User account management -/// -[ApiController] -[Tags("Account")] -[ApiVersion("1"), ApiVersion("2")] -[Route("/{version:apiVersion}/account")] -public sealed partial class AccountController : OpenShockControllerBase -{ - private readonly IAccountService _accountService; - private readonly ILogger _logger; - - public AccountController(IAccountService accountService, ILogger logger) - { - _accountService = accountService; - _logger = logger; - } -} +using Microsoft.AspNetCore.Mvc; +using OpenShock.API.Services.Account; +using OpenShock.Common; + +namespace OpenShock.API.Controller.Account; + +/// +/// User account management +/// +[ApiController] +[Tags("Account")] +[Route("/{version:apiVersion}/account")] +public sealed partial class AccountController : OpenShockControllerBase +{ + private readonly IAccountService _accountService; + private readonly ILogger _logger; + + public AccountController(IAccountService accountService, ILogger logger) + { + _accountService = accountService; + _logger = logger; + } +} diff --git a/API/Controller/Admin/AutomationTokenCreate.cs b/API/Controller/Admin/AutomationTokenCreate.cs index 1329af8f6..7391799fe 100644 --- a/API/Controller/Admin/AutomationTokenCreate.cs +++ b/API/Controller/Admin/AutomationTokenCreate.cs @@ -1,6 +1,7 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Controller.Admin.DTOs; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Models; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Services.Audit; @@ -15,6 +16,7 @@ public sealed partial class AdminController /// Creates an automation token. The secret is only returned once, in this response /// [HttpPost("automationTokens")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] public async Task CreateAutomationToken( diff --git a/API/Controller/Admin/AutomationTokenDelete.cs b/API/Controller/Admin/AutomationTokenDelete.cs index de13f3943..e59d24475 100644 --- a/API/Controller/Admin/AutomationTokenDelete.cs +++ b/API/Controller/Admin/AutomationTokenDelete.cs @@ -1,6 +1,7 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using Npgsql; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Models; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Services.Audit; @@ -14,6 +15,7 @@ public sealed partial class AdminController /// accounts holds a privileged role /// [HttpDelete("automationTokens/{id}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] [ProducesResponseType(StatusCodes.Status409Conflict)] diff --git a/API/Controller/Admin/AutomationTokenList.cs b/API/Controller/Admin/AutomationTokenList.cs index 9bcf4f8f8..498bf0225 100644 --- a/API/Controller/Admin/AutomationTokenList.cs +++ b/API/Controller/Admin/AutomationTokenList.cs @@ -2,6 +2,7 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Controller.Admin.DTOs; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; @@ -11,6 +12,7 @@ public sealed partial class AdminController /// Lists all automation tokens /// [HttpGet("automationTokens")] + [ApiVersion(1)] public async IAsyncEnumerable ListAutomationTokens([EnumeratorCancellation] CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/AutomationTokenPatch.cs b/API/Controller/Admin/AutomationTokenPatch.cs index c42fab893..68e959a3a 100644 --- a/API/Controller/Admin/AutomationTokenPatch.cs +++ b/API/Controller/Admin/AutomationTokenPatch.cs @@ -2,6 +2,7 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Controller.Admin.DTOs; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Models; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Services.Audit; @@ -14,6 +15,7 @@ public sealed partial class AdminController /// Updates an automation token /// [HttpPatch("automationTokens/{id}")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] diff --git a/API/Controller/Admin/AutomationTokenRotate.cs b/API/Controller/Admin/AutomationTokenRotate.cs index 6e09fc1e9..6e7f65b6d 100644 --- a/API/Controller/Admin/AutomationTokenRotate.cs +++ b/API/Controller/Admin/AutomationTokenRotate.cs @@ -1,6 +1,7 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Controller.Admin.DTOs; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Models; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Services.Audit; @@ -15,6 +16,7 @@ public sealed partial class AdminController /// Rotates the secret of an automation token. The new secret is only returned once, in this response /// [HttpPost("automationTokens/{id}/rotate")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] public async Task RotateAutomationToken( diff --git a/API/Controller/Admin/Configuration.cs b/API/Controller/Admin/Configuration.cs index 895485e48..7cadefc22 100644 --- a/API/Controller/Admin/Configuration.cs +++ b/API/Controller/Admin/Configuration.cs @@ -2,6 +2,7 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Controller.Admin.DTOs; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Services.Configuration; using OpenShock.Internal.Common.Problems; @@ -14,9 +15,9 @@ public sealed partial class AdminController /// /// Gets all configuration items /// - /// /// Unauthorized [HttpGet("config")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] // Ok public IAsyncEnumerable ConfigurationList([FromServices] IConfigurationService configurationService) { @@ -44,6 +45,7 @@ public IAsyncEnumerable ConfigurationList([FromServices] I /// Already exists /// Unauthorized [HttpPost("config")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] // Ok [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] // AlreadyExists @@ -77,6 +79,7 @@ public async Task ConfigurationAdd([FromBody] ConfigurationAddIte /// Invalid name or value format or type mismatch /// Not found [HttpPut("config")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] // Ok [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] // AlreadyExists @@ -110,6 +113,7 @@ public async Task ConfigurationUpdate([FromBody] ConfigurationUpd /// Invalid name format /// Not found [HttpDelete("config/{name}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] // Deleted [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // Not found [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // InvalidNameFormat diff --git a/API/Controller/Admin/DeactivateUser.cs b/API/Controller/Admin/DeactivateUser.cs index 99110d51f..9660fd02c 100644 --- a/API/Controller/Admin/DeactivateUser.cs +++ b/API/Controller/Admin/DeactivateUser.cs @@ -1,5 +1,6 @@ using System.ComponentModel.DataAnnotations; using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Constants; using OpenShock.Common.Errors; using AccountSvc = OpenShock.API.Services.Account; @@ -15,6 +16,7 @@ public sealed partial class AdminController /// OK /// Unauthorized [HttpPut("users/{userId}/deactivate")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] public async Task DeactivateUser( [FromRoute] Guid userId, diff --git a/API/Controller/Admin/DeleteApiToken.cs b/API/Controller/Admin/DeleteApiToken.cs index 621576368..0c9db03cb 100644 --- a/API/Controller/Admin/DeleteApiToken.cs +++ b/API/Controller/Admin/DeleteApiToken.cs @@ -1,5 +1,6 @@ using Microsoft.AspNetCore.Mvc; using OpenShock.API.Services.Token; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; @@ -11,6 +12,7 @@ public sealed partial class AdminController /// OK /// Unauthorized [HttpDelete("apitokens/{tokenId}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] public async Task DeleteApiToken([FromRoute] Guid tokenId, [FromServices] IApiTokenService apiTokenService, CancellationToken cancellationToken) { diff --git a/API/Controller/Admin/DeleteUser.cs b/API/Controller/Admin/DeleteUser.cs index 9983f8953..667b99023 100644 --- a/API/Controller/Admin/DeleteUser.cs +++ b/API/Controller/Admin/DeleteUser.cs @@ -1,5 +1,6 @@ using System.ComponentModel.DataAnnotations; using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Constants; using OpenShock.Common.Errors; using AccountSvc = OpenShock.API.Services.Account; @@ -15,6 +16,7 @@ public sealed partial class AdminController /// OK /// Unauthorized [HttpDelete("users/{userId}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] public async Task DeleteUser( [FromRoute] Guid userId, diff --git a/API/Controller/Admin/EmailOutboxBulk.cs b/API/Controller/Admin/EmailOutboxBulk.cs index 6c10389f1..152e277f1 100644 --- a/API/Controller/Admin/EmailOutboxBulk.cs +++ b/API/Controller/Admin/EmailOutboxBulk.cs @@ -2,6 +2,7 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Controller.Admin.DTOs; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Services.RedisPubSub; @@ -17,6 +18,7 @@ public sealed partial class AdminController /// Bulk requeue applied /// Unauthorized [HttpPost("email/outbox/bulk/requeue")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task BulkRequeueEmailOutbox([FromBody] EmailOutboxBulkRequest body, [FromServices] IRedisPubService redisPubService, CancellationToken ct) @@ -51,6 +53,7 @@ public async Task BulkRequeueEmailOutbox([FromBody] Em /// Bulk cancel applied /// Unauthorized [HttpPost("email/outbox/bulk/cancel")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task BulkCancelEmailOutbox([FromBody] EmailOutboxBulkRequest body, CancellationToken ct) @@ -73,6 +76,7 @@ public async Task BulkCancelEmailOutbox([FromBody] Ema /// Bulk delete applied /// Unauthorized [HttpPost("email/outbox/bulk/delete")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task BulkDeleteEmailOutbox([FromBody] EmailOutboxBulkRequest body, CancellationToken ct) diff --git a/API/Controller/Admin/EmailOutboxCancel.cs b/API/Controller/Admin/EmailOutboxCancel.cs index 0bec336f9..bb5a4a2ad 100644 --- a/API/Controller/Admin/EmailOutboxCancel.cs +++ b/API/Controller/Admin/EmailOutboxCancel.cs @@ -1,5 +1,6 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.OpenShockDb; namespace OpenShock.API.Controller.Admin; @@ -15,6 +16,7 @@ public sealed partial class AdminController /// No such message /// Message is not pending [HttpPost("email/outbox/{id}/cancel")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] [ProducesResponseType(StatusCodes.Status409Conflict)] diff --git a/API/Controller/Admin/EmailOutboxDelete.cs b/API/Controller/Admin/EmailOutboxDelete.cs index 19bd972eb..785677af0 100644 --- a/API/Controller/Admin/EmailOutboxDelete.cs +++ b/API/Controller/Admin/EmailOutboxDelete.cs @@ -1,5 +1,6 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; @@ -13,6 +14,7 @@ public sealed partial class AdminController /// Unauthorized /// No such message [HttpDelete("email/outbox/{id}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] public async Task DeleteEmailOutbox([FromRoute] Guid id, CancellationToken ct) diff --git a/API/Controller/Admin/EmailOutboxList.cs b/API/Controller/Admin/EmailOutboxList.cs index 2a5e95fd2..1c47e3c65 100644 --- a/API/Controller/Admin/EmailOutboxList.cs +++ b/API/Controller/Admin/EmailOutboxList.cs @@ -3,6 +3,7 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Controller.Admin.DTOs; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Models; using OpenShock.Internal.DynamicLinq.Extensions; @@ -20,6 +21,7 @@ public sealed partial class AdminController /// Paginated email outbox messages /// Unauthorized [HttpGet("email/outbox")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task GetEmailOutbox( [FromQuery(Name = "$filter")] string filterQuery = "", diff --git a/API/Controller/Admin/EmailOutboxRequeue.cs b/API/Controller/Admin/EmailOutboxRequeue.cs index fa2a89206..befe5475a 100644 --- a/API/Controller/Admin/EmailOutboxRequeue.cs +++ b/API/Controller/Admin/EmailOutboxRequeue.cs @@ -1,5 +1,6 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Services.RedisPubSub; @@ -16,6 +17,7 @@ public sealed partial class AdminController /// No such message /// Message is pending or currently being sent [HttpPost("email/outbox/{id}/requeue")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] [ProducesResponseType(StatusCodes.Status409Conflict)] diff --git a/API/Controller/Admin/EmailOutboxStats.cs b/API/Controller/Admin/EmailOutboxStats.cs index 12cea610f..03a7e6f11 100644 --- a/API/Controller/Admin/EmailOutboxStats.cs +++ b/API/Controller/Admin/EmailOutboxStats.cs @@ -2,6 +2,7 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Controller.Admin.DTOs; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.OpenShockDb; namespace OpenShock.API.Controller.Admin; @@ -14,6 +15,7 @@ public sealed partial class AdminController /// Per-status counts /// Unauthorized [HttpGet("email/outbox/stats")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task GetEmailOutboxStats(CancellationToken cancellationToken) { diff --git a/API/Controller/Admin/EmailOutboxTestSend.cs b/API/Controller/Admin/EmailOutboxTestSend.cs index 24ddf143b..a1db75d74 100644 --- a/API/Controller/Admin/EmailOutboxTestSend.cs +++ b/API/Controller/Admin/EmailOutboxTestSend.cs @@ -1,6 +1,7 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Controller.Admin.DTOs; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Services.RedisPubSub; @@ -17,6 +18,7 @@ public sealed partial class AdminController /// Invalid recipient address /// Unauthorized [HttpPost("email/test")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status400BadRequest)] diff --git a/API/Controller/Admin/EmailProviderBlacklistAdd.cs b/API/Controller/Admin/EmailProviderBlacklistAdd.cs index 19c3d9e83..d5d1b7370 100644 --- a/API/Controller/Admin/EmailProviderBlacklistAdd.cs +++ b/API/Controller/Admin/EmailProviderBlacklistAdd.cs @@ -2,6 +2,7 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Controller.Admin.DTOs; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.OpenShockDb; namespace OpenShock.API.Controller.Admin; @@ -9,6 +10,7 @@ namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController { [HttpPost("blacklist/emailProviders")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] public async Task AddEmailProviderBlacklist([FromBody] AddEmailProviderBlacklistDto body, CancellationToken ct) diff --git a/API/Controller/Admin/EmailProviderBlacklistList.cs b/API/Controller/Admin/EmailProviderBlacklistList.cs index 6891258fa..a5327ae47 100644 --- a/API/Controller/Admin/EmailProviderBlacklistList.cs +++ b/API/Controller/Admin/EmailProviderBlacklistList.cs @@ -3,12 +3,14 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Controller.Admin.DTOs; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController { [HttpGet("blacklist/emailProviders")] + [ApiVersion(1)] public async IAsyncEnumerable ListEmailProviderBlacklist([FromQuery(Name="match")] string? match, [EnumeratorCancellation] CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/EmailProviderBlacklistRemove.cs b/API/Controller/Admin/EmailProviderBlacklistRemove.cs index 668f5d0c5..03327bcf5 100644 --- a/API/Controller/Admin/EmailProviderBlacklistRemove.cs +++ b/API/Controller/Admin/EmailProviderBlacklistRemove.cs @@ -1,11 +1,13 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController { [HttpDelete("blacklist/emailProviders/{id}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] public async Task RemoveEmailProviderBlacklist([FromRoute] Guid id, CancellationToken ct) diff --git a/API/Controller/Admin/GetAuditLog.cs b/API/Controller/Admin/GetAuditLog.cs index 5d0be5d22..20db8b3d3 100644 --- a/API/Controller/Admin/GetAuditLog.cs +++ b/API/Controller/Admin/GetAuditLog.cs @@ -2,6 +2,7 @@ using Microsoft.AspNetCore.Mvc; using OpenShock.API.Controller.Account.Authenticated; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Services.Audit; using OpenShock.Common.Utils.Pagination; @@ -19,6 +20,7 @@ public sealed partial class AdminController /// /// A page of audit log entries. [HttpGet("audit-log")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task> GetAdminAuditLog( [FromQuery] PaginationQuery pagination, diff --git a/API/Controller/Admin/GetOnlineDevices.cs b/API/Controller/Admin/GetOnlineDevices.cs index 10c0efa69..82df01596 100644 --- a/API/Controller/Admin/GetOnlineDevices.cs +++ b/API/Controller/Admin/GetOnlineDevices.cs @@ -3,6 +3,7 @@ using System.Text.Json.Serialization; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Extensions; using OpenShock.Common.JsonSerialization; using OpenShock.Common.Models; @@ -19,6 +20,7 @@ public sealed partial class AdminController /// All online devices /// Unauthorized [HttpGet("monitoring/onlineDevices")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task GetOnlineDevices(CancellationToken cancellationToken) { diff --git a/API/Controller/Admin/GetOnlineGateways.cs b/API/Controller/Admin/GetOnlineGateways.cs index 8e28141f7..ec2f411fa 100644 --- a/API/Controller/Admin/GetOnlineGateways.cs +++ b/API/Controller/Admin/GetOnlineGateways.cs @@ -1,5 +1,6 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Redis; namespace OpenShock.API.Controller.Admin; @@ -12,6 +13,7 @@ public sealed partial class AdminController /// All online gateways /// Unauthorized [HttpGet("monitoring/gateways")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task GetOnlineGateways() { diff --git a/API/Controller/Admin/GetUser.cs b/API/Controller/Admin/GetUser.cs index 0b3fc07df..32e269beb 100644 --- a/API/Controller/Admin/GetUser.cs +++ b/API/Controller/Admin/GetUser.cs @@ -3,6 +3,7 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Constants; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Utils; @@ -237,6 +238,7 @@ public sealed class AdminUserView /// Not found /// Unauthorized [HttpGet("users/{userId}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound)] public async Task GetUserById([FromRoute(Name = "userId")] Guid userId, CancellationToken cancellationToken) diff --git a/API/Controller/Admin/GetUsers.cs b/API/Controller/Admin/GetUsers.cs index fc55fc592..df85dd13e 100644 --- a/API/Controller/Admin/GetUsers.cs +++ b/API/Controller/Admin/GetUsers.cs @@ -2,6 +2,7 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Models; using OpenShock.Common.OpenShockDb; @@ -19,6 +20,7 @@ public sealed partial class AdminController /// Paginated users /// Unauthorized [HttpGet("users")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task GetUsers( [FromQuery(Name = "$filter")] string filterQuery = "", diff --git a/API/Controller/Admin/PatchUser.cs b/API/Controller/Admin/PatchUser.cs index 4f2e96e2b..05b5538c4 100644 --- a/API/Controller/Admin/PatchUser.cs +++ b/API/Controller/Admin/PatchUser.cs @@ -2,6 +2,7 @@ using Microsoft.AspNetCore.Mvc; using OpenShock.API.Controller.Admin.DTOs; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; @@ -14,6 +15,7 @@ public sealed partial class AdminController /// Not found /// Unauthorized [HttpPatch("users/{userId}")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] public async Task ModifyUser([FromRoute] Guid userId, [FromBody] UserPatchDto body, [FromServices] IAccountService accountService, CancellationToken ct) diff --git a/API/Controller/Admin/ReactivateUser.cs b/API/Controller/Admin/ReactivateUser.cs index b72664b73..10f6db79c 100644 --- a/API/Controller/Admin/ReactivateUser.cs +++ b/API/Controller/Admin/ReactivateUser.cs @@ -1,5 +1,6 @@ using System.ComponentModel.DataAnnotations; using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Constants; using OpenShock.Common.Errors; using AccountSvc = OpenShock.API.Services.Account; @@ -15,6 +16,7 @@ public sealed partial class AdminController /// OK /// Unauthorized [HttpPut("users/{userId}/reactivate")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] public async Task ReactivateUser( [FromRoute] Guid userId, diff --git a/API/Controller/Admin/SetUserEmail.cs b/API/Controller/Admin/SetUserEmail.cs index 83f4bd3a9..49252369c 100644 --- a/API/Controller/Admin/SetUserEmail.cs +++ b/API/Controller/Admin/SetUserEmail.cs @@ -1,6 +1,7 @@ using System.Diagnostics; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.DataAnnotations; using OpenShock.Common.Errors; using Results = OpenShock.Common.Results; @@ -16,6 +17,7 @@ public sealed partial class AdminController /// Not found /// Unauthorized [HttpPut("users/{userId}/email")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] public async Task SetUserEmail([FromRoute(Name = "userId")] Guid userId, [FromBody] SetUserEmailRequestBody body, [FromServices] IAccountService accountService, CancellationToken cancellationToken) diff --git a/API/Controller/Admin/SetUserName.cs b/API/Controller/Admin/SetUserName.cs index 091f14a5b..b3e603ecb 100644 --- a/API/Controller/Admin/SetUserName.cs +++ b/API/Controller/Admin/SetUserName.cs @@ -2,6 +2,7 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.DataAnnotations; using OpenShock.Common.Errors; using OpenShock.Common.Validation; @@ -20,6 +21,7 @@ public sealed partial class AdminController /// Unauthorized /// The target account is deactivated or not yet activated [HttpPut("users/{userId}/name")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] diff --git a/API/Controller/Admin/SetUserPassword.cs b/API/Controller/Admin/SetUserPassword.cs index daab44d72..3b30ce163 100644 --- a/API/Controller/Admin/SetUserPassword.cs +++ b/API/Controller/Admin/SetUserPassword.cs @@ -2,6 +2,7 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.DataAnnotations; using OpenShock.Common.Errors; using OpenShock.Internal.Common.Problems; @@ -19,6 +20,7 @@ public sealed partial class AdminController /// Unauthorized /// The target account is deactivated or not yet activated [HttpPut("users/{userId}/password")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] diff --git a/API/Controller/Admin/UserNameBlacklistAdd.cs b/API/Controller/Admin/UserNameBlacklistAdd.cs index 18369ede9..83feb5869 100644 --- a/API/Controller/Admin/UserNameBlacklistAdd.cs +++ b/API/Controller/Admin/UserNameBlacklistAdd.cs @@ -1,6 +1,7 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Controller.Admin.DTOs; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.OpenShockDb; namespace OpenShock.API.Controller.Admin; @@ -8,6 +9,7 @@ namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController { [HttpPost("blacklist/usernames")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] public async Task AddUsernameBlacklist([FromBody] AddUsernameBlacklistDto body, CancellationToken cancellationToken) diff --git a/API/Controller/Admin/UserNameBlacklistList.cs b/API/Controller/Admin/UserNameBlacklistList.cs index 55981054e..f02e5a698 100644 --- a/API/Controller/Admin/UserNameBlacklistList.cs +++ b/API/Controller/Admin/UserNameBlacklistList.cs @@ -2,12 +2,14 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Controller.Admin.DTOs; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController { [HttpGet("blacklist/usernames")] + [ApiVersion(1)] public async IAsyncEnumerable ListUsernameBlacklist([FromQuery(Name="match")] string? match, [EnumeratorCancellation] CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/UserNameBlacklistRemove.cs b/API/Controller/Admin/UserNameBlacklistRemove.cs index 54c08d066..b98772c62 100644 --- a/API/Controller/Admin/UserNameBlacklistRemove.cs +++ b/API/Controller/Admin/UserNameBlacklistRemove.cs @@ -1,11 +1,13 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController { [HttpDelete("blacklist/usernames/{id}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] public async Task RemoveUsernameBlacklist([FromRoute] Guid id, CancellationToken ct) diff --git a/API/Controller/Admin/WebhookAdd.cs b/API/Controller/Admin/WebhookAdd.cs index ea890ef63..3abd30588 100644 --- a/API/Controller/Admin/WebhookAdd.cs +++ b/API/Controller/Admin/WebhookAdd.cs @@ -1,6 +1,7 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Controller.Admin.DTOs; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Models; using OpenShock.Common.Results; @@ -16,6 +17,7 @@ public sealed partial class AdminController /// OK /// Unauthorized [HttpPost("webhooks")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] diff --git a/API/Controller/Admin/WebhookList.cs b/API/Controller/Admin/WebhookList.cs index 7299d1d01..e90a0fed3 100644 --- a/API/Controller/Admin/WebhookList.cs +++ b/API/Controller/Admin/WebhookList.cs @@ -1,4 +1,5 @@ using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Models; using OpenShock.Common.Services.Webhook; @@ -12,6 +13,7 @@ public sealed partial class AdminController /// OK /// Unauthorized [HttpGet("webhooks")] + [ApiVersion(1)] public async Task ListWebhooks([FromServices] IWebhookService webhookService, CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/WebhookRemove.cs b/API/Controller/Admin/WebhookRemove.cs index 10be32d84..843d97019 100644 --- a/API/Controller/Admin/WebhookRemove.cs +++ b/API/Controller/Admin/WebhookRemove.cs @@ -1,4 +1,5 @@ using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Services.Webhook; @@ -12,6 +13,7 @@ public sealed partial class AdminController /// OK /// Unauthorized [HttpDelete("webhooks/{id}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] public async Task RemoveWebhook([FromRoute] Guid id, [FromServices] IWebhookService webhookService, CancellationToken cancellationToken) diff --git a/API/Controller/Device/AssignLCG.cs b/API/Controller/Device/AssignLCG.cs index 443546496..d29547467 100644 --- a/API/Controller/Device/AssignLCG.cs +++ b/API/Controller/Device/AssignLCG.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Response; using OpenShock.API.Services.LCGNodeProvisioner; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Models; using OpenShock.Common.Services.Geo; @@ -19,7 +19,7 @@ public sealed partial class DeviceController /// Successfully assigned LCG node /// Unable to find suitable LCG node [HttpGet("assignLCG")] - [MapToApiVersion("1")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status503ServiceUnavailable, MediaTypeNames.Application.ProblemJson)] // NoLcgNodesAvailable public async Task GetLiveControlGateway([FromServices] ILCGNodeProvisioner geoLocation, [FromServices] IIpEnrichmentService ipEnrichment) diff --git a/API/Controller/Device/AssignLCGV2.cs b/API/Controller/Device/AssignLCGV2.cs index d2ca77274..b68fdf05e 100644 --- a/API/Controller/Device/AssignLCGV2.cs +++ b/API/Controller/Device/AssignLCGV2.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Response; using OpenShock.API.Services.LCGNodeProvisioner; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Services.Geo; using OpenShock.Common.Utils; @@ -18,7 +18,7 @@ public sealed partial class DeviceController /// Successfully assigned LCG node /// Unable to find suitable LCG node [HttpGet("assignLCG")] - [MapToApiVersion("2")] + [ApiVersion(2)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // BadSchemaVersion [ProducesResponseType(StatusCodes.Status503ServiceUnavailable, MediaTypeNames.Application.ProblemJson)] // NoLcgNodesAvailable diff --git a/API/Controller/Device/GetSelf.cs b/API/Controller/Device/GetSelf.cs index 21461b8f7..5beb091bd 100644 --- a/API/Controller/Device/GetSelf.cs +++ b/API/Controller/Device/GetSelf.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication; using OpenShock.Common.Extensions; using OpenShock.Common.Models; @@ -16,7 +16,7 @@ public sealed partial class DeviceController /// /// The device information was successfully retrieved. [HttpGet("self")] - [MapToApiVersion("1")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task GetSelf(CancellationToken cancellationToken) { diff --git a/API/Controller/Device/Pair.cs b/API/Controller/Device/Pair.cs index 6775d0eca..64b32b484 100644 --- a/API/Controller/Device/Pair.cs +++ b/API/Controller/Device/Pair.cs @@ -1,9 +1,9 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Models; using OpenShock.Common.Redis; @@ -20,11 +20,11 @@ public sealed partial class DeviceController /// /// Successfully assigned LCG node /// No such pair code exists - [AllowAnonymous] - [MapToApiVersion("1")] [HttpGet("pair/{pairCode}", Name = "Pair")] - [EndpointName("PairDeviceByCode")] + [ApiVersion(1)] + [AllowAnonymous] [EnableRateLimiting("auth")] + [EndpointName("PairDeviceByCode")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // PairCodeNotFound public async Task Pair([FromRoute] string pairCode, CancellationToken cancellationToken) @@ -35,11 +35,11 @@ public async Task Pair([FromRoute] string pairCode, CancellationT /// /// Pair a device with a pair code, legacy endpoint kept for backwards compatibility /// - [AllowAnonymous] - [MapToApiVersion("1")] [HttpGet("~/{version:apiVersion}/pair/{pairCode}")] - [ApiExplorerSettings(IgnoreApi = true)] + [ApiVersion(1)] + [AllowAnonymous] [EnableRateLimiting("auth")] + [ApiExplorerSettings(IgnoreApi = true)] public async Task PairDeprecated([FromRoute] string pairCode, CancellationToken cancellationToken) { return await PairInternal(pairCode, cancellationToken); diff --git a/API/Controller/Device/_ApiController.cs b/API/Controller/Device/_ApiController.cs index 1bfde0ad9..549b2ce2d 100644 --- a/API/Controller/Device/_ApiController.cs +++ b/API/Controller/Device/_ApiController.cs @@ -1,5 +1,4 @@ -using Asp.Versioning; -using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Services.DeviceUpdate; using OpenShock.Common; @@ -13,8 +12,6 @@ namespace OpenShock.API.Controller.Device; /// For devices (ESP's) /// [ApiController] -[ApiVersion("1")] -[ApiVersion("2")] [Tags("Hub Endpoints")] [Route("/{version:apiVersion}/device")] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.HubToken)] diff --git a/API/Controller/Devices/DeviceOtaController.cs b/API/Controller/Devices/DeviceOtaController.cs index 162f00462..63171e8b7 100644 --- a/API/Controller/Devices/DeviceOtaController.cs +++ b/API/Controller/Devices/DeviceOtaController.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication; using OpenShock.Common.Authentication.ControllerBase; using OpenShock.Common.Errors; @@ -16,7 +16,6 @@ namespace OpenShock.API.Controller.Devices; [ApiController] [Tags("Hub Management")] -[ApiVersion("1")] [Route("/{version:apiVersion}/devices")] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.UserSessionCookie)] public sealed class DevicesOtaController : AuthenticatedSessionControllerBase @@ -39,7 +38,7 @@ public DevicesOtaController(OpenShockContext db, ILogger logg /// OK /// Could not find device or you do not have access to it [HttpGet("{deviceId}/ota")] - [MapToApiVersion("1")] + [ApiVersion(1)] [ProducesResponseType>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound public async Task GetOtaUpdateHistory([FromRoute] Guid deviceId, [FromServices] IOtaService otaService, CancellationToken cancellationToken) diff --git a/API/Controller/Devices/DevicesController.cs b/API/Controller/Devices/DevicesController.cs index 159610340..b5ecddeb0 100644 --- a/API/Controller/Devices/DevicesController.cs +++ b/API/Controller/Devices/DevicesController.cs @@ -1,11 +1,11 @@ using System.Net.Mime; using System.Security.Cryptography; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; using OpenShock.API.Models.Response; using OpenShock.API.Services.DeviceUpdate; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.Extensions; @@ -27,7 +27,7 @@ public sealed partial class DevicesController /// /// All devices for the current user [HttpGet] - [MapToApiVersion("1")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public IActionResult ListDevices() { @@ -51,9 +51,9 @@ public IActionResult ListDevices() /// /// The device [HttpGet("{deviceId}")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound - [MapToApiVersion("1")] public async Task GetDeviceById([FromRoute] Guid deviceId, CancellationToken cancellationToken) { var hasAuthPerms = IsAllowed(PermissionType.Devices_Auth); @@ -82,11 +82,11 @@ public async Task GetDeviceById([FromRoute] Guid deviceId, Cancel /// Successfully updated device /// Device does not exist [HttpPatch("{deviceId}")] + [ApiVersion(1)] [TokenPermission(PermissionType.Devices_Edit)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound - [MapToApiVersion("1")] public async Task EditDevice([FromRoute] Guid deviceId, [FromBody] HubEditRequest body, [FromServices] IDeviceUpdateService updateService, CancellationToken cancellationToken) { var device = await _db.Devices.FirstOrDefaultAsync(x => x.OwnerId == CurrentUser.Id && x.Id == deviceId, cancellationToken); @@ -109,10 +109,10 @@ public async Task EditDevice([FromRoute] Guid deviceId, [FromBody /// Device does not exist /// Failed to save regenerated token [HttpPut("{deviceId}")] + [ApiVersion(1)] [TokenPermission(PermissionType.Devices_Edit)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Text.Plain)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound - [MapToApiVersion("1")] public async Task RegenerateDeviceToken([FromRoute] Guid deviceId, CancellationToken cancellationToken) { var device = await _db.Devices.FirstOrDefaultAsync(x => x.OwnerId == CurrentUser.Id && x.Id == deviceId, cancellationToken); @@ -135,10 +135,10 @@ public async Task RegenerateDeviceToken([FromRoute] Guid deviceId /// Successfully deleted device /// Device does not exist [HttpDelete("{deviceId}")] + [ApiVersion(1)] [TokenPermission(PermissionType.Devices_Edit)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound - [MapToApiVersion("1")] public async Task RemoveDevice([FromRoute] Guid deviceId, [FromServices] IDeviceUpdateService updateService, CancellationToken cancellationToken) { var affected = await _db.Devices.Where(x => x.Id == deviceId).WhereIsUserOrPrivileged(x => x.Owner, CurrentUser).ExecuteDeleteAsync(cancellationToken); @@ -154,9 +154,9 @@ public async Task RemoveDevice([FromRoute] Guid deviceId, [FromSe /// /// Successfully created device [HttpPost] + [ApiVersion(1)] [TokenPermission(PermissionType.Devices_Edit)] [ProducesResponseType(StatusCodes.Status201Created, MediaTypeNames.Text.Plain)] - [MapToApiVersion("1")] public Task CreateDevice([FromServices] IDeviceUpdateService updateService, CancellationToken cancellationToken) => CreateDeviceV2(new HubCreateRequest { @@ -169,10 +169,10 @@ public Task CreateDevice([FromServices] IDeviceUpdateService upda /// /// Successfully created device [HttpPost] + [ApiVersion(2)] [TokenPermission(PermissionType.Devices_Edit)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status201Created, MediaTypeNames.Text.Plain)] - [MapToApiVersion("2")] public async Task CreateDeviceV2([FromBody] HubCreateRequest body, [FromServices] IDeviceUpdateService updateService, CancellationToken cancellationToken) { int nDevices = await _db.Devices.CountAsync(d => d.OwnerId == CurrentUser.Id, cancellationToken); @@ -203,10 +203,10 @@ public async Task CreateDeviceV2([FromBody] HubCreateRequest body /// The pair code /// Device does not exist or does not belong to you [HttpGet("{deviceId}/pair")] + [ApiVersion(1)] [TokenPermission(PermissionType.Devices_Edit)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound - [MapToApiVersion("1")] public async Task GetPairCode([FromRoute] Guid deviceId, CancellationToken cancellationToken) { var devicePairs = _redis.RedisCollection(); @@ -236,9 +236,9 @@ public async Task GetPairCode([FromRoute] Guid deviceId, Cancella /// Device does not exist or does not belong to you /// Device is not online [HttpGet("{deviceId}/lcg")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound, DeviceIsNotOnline - [MapToApiVersion("1")] public async Task GetLiveControlGatewayInfo([FromRoute] Guid deviceId, CancellationToken cancellationToken) { var result = await ResolveDeviceGatewayAsync(deviceId, cancellationToken); @@ -258,9 +258,9 @@ public async Task GetLiveControlGatewayInfo([FromRoute] Guid devi /// Successfully retrieved live control gateway info /// Device does not exist or is not online [HttpGet("{deviceId}/lcg")] + [ApiVersion(2)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound, DeviceIsNotOnline - [MapToApiVersion("2")] public async Task GetLiveControlGatewayInfoV2([FromRoute] Guid deviceId, CancellationToken cancellationToken) { var result = await ResolveDeviceGatewayAsync(deviceId, cancellationToken); diff --git a/API/Controller/Devices/GetShockers.cs b/API/Controller/Devices/GetShockers.cs index f18749ad2..bab8d4cf9 100644 --- a/API/Controller/Devices/GetShockers.cs +++ b/API/Controller/Devices/GetShockers.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Models; using OpenShock.Internal.Common.Problems; @@ -19,9 +19,9 @@ public sealed partial class DevicesController /// All shockers for the device /// Device does not exists or you do not have access to it. [HttpGet("{deviceId}/shockers")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound - [MapToApiVersion("1")] public async Task GetShockers([FromRoute] Guid deviceId, CancellationToken cancellationToken) { var deviceExists = await _db.Devices.AnyAsync(x => x.OwnerId == CurrentUser.Id && x.Id == deviceId, cancellationToken); diff --git a/API/Controller/Devices/_ApiController.cs b/API/Controller/Devices/_ApiController.cs index bcd70b334..5e90e7eee 100644 --- a/API/Controller/Devices/_ApiController.cs +++ b/API/Controller/Devices/_ApiController.cs @@ -1,5 +1,4 @@ -using Asp.Versioning; -using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using OpenShock.Common.Authentication; using OpenShock.Common.Authentication.ControllerBase; @@ -13,7 +12,6 @@ namespace OpenShock.API.Controller.Devices; /// [ApiController] [Tags("Hub Management")] -[ApiVersion("1"), ApiVersion("2")] [Route("/{version:apiVersion}/devices")] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.UserSessionApiTokenCombo)] public sealed partial class DevicesController : AuthenticatedSessionControllerBase diff --git a/API/Controller/Integrations/GetControlStatChanges.cs b/API/Controller/Integrations/GetControlStatChanges.cs index 4485ef2ee..21bc35465 100644 --- a/API/Controller/Integrations/GetControlStatChanges.cs +++ b/API/Controller/Integrations/GetControlStatChanges.cs @@ -5,6 +5,7 @@ using OpenShock.API.Errors; using OpenShock.API.Models.Requests; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Extensions; using OpenShock.Common.OpenShockDb; using OpenShock.Internal.Common.Problems; @@ -28,6 +29,7 @@ public sealed partial class IntegrationsController /// The changed users' totals and the cursor to pass next time. /// No automation token granting ControlStatsRead was presented. [HttpPost("control-stats/changes")] + [ApiVersion(1)] [EnableRateLimiting("control-stats")] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] // MissingCapability diff --git a/API/Controller/OAuth/Authorize.cs b/API/Controller/OAuth/Authorize.cs index d27258c04..28d4a13de 100644 --- a/API/Controller/OAuth/Authorize.cs +++ b/API/Controller/OAuth/Authorize.cs @@ -2,6 +2,7 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.OAuth; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Extensions; namespace OpenShock.API.Controller.OAuth; @@ -18,8 +19,9 @@ public sealed partial class OAuthController /// Flow to run /// Redirect to the provider authorization page. /// Unsupported or misconfigured provider. - [EnableRateLimiting("auth")] [HttpPost("{provider}/authorize")] + [ApiVersion(1)] + [EnableRateLimiting("auth")] [ApiExplorerSettings(IgnoreApi = true)] public async Task OAuthAuthorize([FromRoute] string provider, [FromQuery(Name="flow"), Required] OAuthFlow flow) { diff --git a/API/Controller/OAuth/HandOff.cs b/API/Controller/OAuth/HandOff.cs index 8b87488e7..89a22a441 100644 --- a/API/Controller/OAuth/HandOff.cs +++ b/API/Controller/OAuth/HandOff.cs @@ -4,6 +4,7 @@ using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.OAuth; using OpenShock.API.Services.OAuthConnection; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Extensions; using OpenShock.Common.Options; @@ -19,8 +20,9 @@ public sealed partial class OAuthController /// If a matching connection exists -> signs in and redirects home. /// Otherwise -> redirects frontend to continue the chosen flow. /// - [EnableRateLimiting("auth")] [HttpGet("{provider}/handoff")] + [ApiVersion(1)] + [EnableRateLimiting("auth")] [ApiExplorerSettings(IgnoreApi = true)] public async Task OAuthHandOff( [FromRoute] string provider, diff --git a/API/Controller/OAuth/SignupFinalize.cs b/API/Controller/OAuth/SignupFinalize.cs index 4276f2fb2..9943cad7a 100644 --- a/API/Controller/OAuth/SignupFinalize.cs +++ b/API/Controller/OAuth/SignupFinalize.cs @@ -6,6 +6,7 @@ using OpenShock.API.Models.Response; using OpenShock.API.OAuth; using OpenShock.API.Services.OAuthConnection; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication; using OpenShock.Common.Errors; using OpenShock.Common.Extensions; @@ -28,8 +29,9 @@ public sealed partial class OAuthController /// /// /// - [EnableRateLimiting("auth")] [HttpPost("{provider}/signup-finalize")] + [ApiVersion(1)] + [EnableRateLimiting("auth")] [ApiExplorerSettings(IgnoreApi = true)] public async Task OAuthSignupFinalize( [FromRoute] string provider, diff --git a/API/Controller/OAuth/SignupGetData.cs b/API/Controller/OAuth/SignupGetData.cs index 24749f6d9..fa9968fbb 100644 --- a/API/Controller/OAuth/SignupGetData.cs +++ b/API/Controller/OAuth/SignupGetData.cs @@ -3,6 +3,7 @@ using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.Models.Response; using OpenShock.API.OAuth; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Extensions; namespace OpenShock.API.Controller.OAuth; @@ -19,9 +20,10 @@ public sealed partial class OAuthController /// who initiated the flow. /// /// The provider key (e.g. discord). - [ResponseCache(NoStore = true)] - [EnableRateLimiting("auth")] [HttpGet("{provider}/signup-data")] + [ApiVersion(1)] + [EnableRateLimiting("auth")] + [ResponseCache(NoStore = true)] [ApiExplorerSettings(IgnoreApi = true)] public async Task OAuthSignupGetData([FromRoute] string provider) { diff --git a/API/Controller/OAuth/_ApiController.cs b/API/Controller/OAuth/_ApiController.cs index 345b9f05a..87de71d25 100644 --- a/API/Controller/OAuth/_ApiController.cs +++ b/API/Controller/OAuth/_ApiController.cs @@ -1,5 +1,4 @@ using System.Security.Claims; -using Asp.Versioning; using Microsoft.AspNetCore.Authentication; using Microsoft.AspNetCore.Mvc; using OpenShock.API.OAuth; @@ -14,7 +13,6 @@ namespace OpenShock.API.Controller.OAuth; /// [ApiController] [Tags("OAuth")] -[ApiVersion("1")] [Route("/{version:apiVersion}/oauth")] public sealed partial class OAuthController : OpenShockControllerBase { diff --git a/API/Controller/Public/GetStats.cs b/API/Controller/Public/GetStats.cs index 655bbfc38..48170a185 100644 --- a/API/Controller/Public/GetStats.cs +++ b/API/Controller/Public/GetStats.cs @@ -1,6 +1,7 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using NRedisStack.RedisStackCommands; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Models; using OpenShock.Common.Redis; using StackExchange.Redis; @@ -15,6 +16,7 @@ public sealed partial class PublicController /// The statistics were successfully retrieved. [Tags("Meta")] [HttpGet("stats")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task GetOnlineDevicesStatistics([FromServices] IConnectionMultiplexer redisConnectionMultiplexer) { diff --git a/API/Controller/Public/PublicShareController.cs b/API/Controller/Public/PublicShareController.cs index 25dbef0f0..fa5c71ce6 100644 --- a/API/Controller/Public/PublicShareController.cs +++ b/API/Controller/Public/PublicShareController.cs @@ -3,6 +3,7 @@ using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; using OpenShock.API.Utils; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Extensions; using OpenShock.Common.Models; @@ -19,8 +20,9 @@ public sealed partial class PublicController /// /// The public share information was successfully retrieved. /// The public share does not exist. - [HttpGet("shares/links/{publicShareId}")] [Tags("Public Shocker Shares")] + [HttpGet("shares/links/{publicShareId}")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // PublicShareNotFound public async Task GetPublicShare([FromRoute] Guid publicShareId, CancellationToken cancellationToken) diff --git a/API/Controller/Sessions/DeleteSessions.cs b/API/Controller/Sessions/DeleteSessions.cs index 099866bcd..e52cfe53b 100644 --- a/API/Controller/Sessions/DeleteSessions.cs +++ b/API/Controller/Sessions/DeleteSessions.cs @@ -1,5 +1,6 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Extensions; using OpenShock.Common.OpenShockDb; @@ -10,6 +11,7 @@ namespace OpenShock.API.Controller.Sessions; public sealed partial class SessionsController { [HttpDelete("{sessionId}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // SessionNotFound public async Task DeleteSession([FromRoute] Guid sessionId) diff --git a/API/Controller/Sessions/ListSessions.cs b/API/Controller/Sessions/ListSessions.cs index 0be0b5433..84a2e277d 100644 --- a/API/Controller/Sessions/ListSessions.cs +++ b/API/Controller/Sessions/ListSessions.cs @@ -1,12 +1,14 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Sessions; public sealed partial class SessionsController { [HttpGet] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public IAsyncEnumerable ListSessions() { diff --git a/API/Controller/Sessions/SessionSelf.cs b/API/Controller/Sessions/SessionSelf.cs index e8beb2770..497b9cd04 100644 --- a/API/Controller/Sessions/SessionSelf.cs +++ b/API/Controller/Sessions/SessionSelf.cs @@ -1,5 +1,6 @@ using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Redis; namespace OpenShock.API.Controller.Sessions; @@ -9,9 +10,9 @@ public sealed partial class SessionsController /// /// Gets information about the current token used to access this endpoint /// - /// /// [HttpGet("self")] + [ApiVersion(1)] public LoginSessionResponse GetSelfSession() { return LoginSessionResponse.MapFrom(GetRequiredItem(), _logger); diff --git a/API/Controller/Sessions/_ApiController.cs b/API/Controller/Sessions/_ApiController.cs index a03995c3c..1a480c9e9 100644 --- a/API/Controller/Sessions/_ApiController.cs +++ b/API/Controller/Sessions/_ApiController.cs @@ -1,5 +1,4 @@ -using Asp.Versioning; -using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using OpenShock.Common.Authentication; using OpenShock.Common.Authentication.ControllerBase; @@ -12,7 +11,6 @@ namespace OpenShock.API.Controller.Sessions; /// [ApiController] [Tags("Sessions")] -[ApiVersion("1")] [Route("/{version:apiVersion}/sessions")] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.UserSessionCookie)] public sealed partial class SessionsController : AuthenticatedSessionControllerBase diff --git a/API/Controller/Shares/DeleteShareCode.cs b/API/Controller/Shares/DeleteShareCode.cs index 617bfbd38..e14af033d 100644 --- a/API/Controller/Shares/DeleteShareCode.cs +++ b/API/Controller/Shares/DeleteShareCode.cs @@ -1,7 +1,7 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Extensions; using OpenShock.Common.Models; @@ -19,9 +19,9 @@ public sealed partial class SharesController /// Deleted share code /// Share code not found or does not belong to you [HttpDelete("code/{shareCodeId}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShareCodeNotFound - [MapToApiVersion("1")] public async Task DeleteShareCode([FromRoute] Guid shareCodeId, CancellationToken cancellationToken) { var affected = await _db.ShockerShareCodes diff --git a/API/Controller/Shares/LinkShareCode.cs b/API/Controller/Shares/LinkShareCode.cs index 3c798f51e..9db601b35 100644 --- a/API/Controller/Shares/LinkShareCode.cs +++ b/API/Controller/Shares/LinkShareCode.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Services.DeviceUpdate; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Models; using OpenShock.Common.OpenShockDb; @@ -23,10 +23,10 @@ public sealed partial class SharesController /// You cannot link your own shocker code / You already have this shocker linked to your account /// Error while linking share code to your account [HttpPost("code/{shareCodeId}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShareCodeNotFound [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // CantLinkOwnShareCode, ShockerAlreadyLinked - [MapToApiVersion("1")] public async Task LinkShareCode( [FromRoute] Guid shareCodeId, [FromServices] IDeviceUpdateService deviceUpdateService, diff --git a/API/Controller/Shares/Links/AddShocker.cs b/API/Controller/Shares/Links/AddShocker.cs index 9c2b43915..a60fac59e 100644 --- a/API/Controller/Shares/Links/AddShocker.cs +++ b/API/Controller/Shares/Links/AddShocker.cs @@ -1,6 +1,7 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.Models; @@ -21,6 +22,7 @@ public sealed partial class ShareLinksController /// Public share or shocker does not exist /// Shocker already exists in public share [HttpPost("{publicShareId}/{shockerId}")] + [ApiVersion(1)] [TokenPermission(PermissionType.Publicshares_Edit)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // PublicShareNotFound, ShockerNotFound diff --git a/API/Controller/Shares/Links/CreatePublicShare.cs b/API/Controller/Shares/Links/CreatePublicShare.cs index e77fa1d32..77018adb3 100644 --- a/API/Controller/Shares/Links/CreatePublicShare.cs +++ b/API/Controller/Shares/Links/CreatePublicShare.cs @@ -1,6 +1,7 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Requests; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.Models; @@ -15,6 +16,7 @@ public sealed partial class ShareLinksController /// /// The created public share [HttpPost(Name = "CreatePublicShare")] + [ApiVersion(1)] [TokenPermission(PermissionType.Publicshares_Edit)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] diff --git a/API/Controller/Shares/Links/DeletePublicShare.cs b/API/Controller/Shares/Links/DeletePublicShare.cs index e99fd7d89..330a68e22 100644 --- a/API/Controller/Shares/Links/DeletePublicShare.cs +++ b/API/Controller/Shares/Links/DeletePublicShare.cs @@ -1,6 +1,7 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.Extensions; @@ -20,6 +21,7 @@ public sealed partial class ShareLinksController /// Deleted public share /// Public share not found or does not belong to you [HttpDelete("{publicShareId}")] + [ApiVersion(1)] [TokenPermission(PermissionType.Publicshares_Edit)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // PublicShareNotFound diff --git a/API/Controller/Shares/Links/EditShocker.cs b/API/Controller/Shares/Links/EditShocker.cs index db263a2d2..594359468 100644 --- a/API/Controller/Shares/Links/EditShocker.cs +++ b/API/Controller/Shares/Links/EditShocker.cs @@ -2,6 +2,7 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.OpenShockDb; @@ -22,8 +23,9 @@ public sealed partial class ShareLinksController /// Public share or shocker does not exist /// Shocker does not exist in public share [HttpPatch("{publicShareId}/{shockerId}")] - [Consumes(MediaTypeNames.Application.Json)] + [ApiVersion(1)] [TokenPermission(PermissionType.Publicshares_Edit)] + [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Text.Plain)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // PublicShareNotFound, ShockerNotInPublicShare public async Task EditShocker([FromRoute] Guid publicShareId, [FromRoute] Guid shockerId, [FromBody] PublicShareEditShocker body, CancellationToken cancellationToken) diff --git a/API/Controller/Shares/Links/List.cs b/API/Controller/Shares/Links/List.cs index 77eb5873c..e74f9345e 100644 --- a/API/Controller/Shares/Links/List.cs +++ b/API/Controller/Shares/Links/List.cs @@ -2,6 +2,7 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Models; using OpenShock.Common.OpenShockDb; @@ -15,6 +16,7 @@ public sealed partial class ShareLinksController /// /// All public shares for the current user [HttpGet] + [ApiVersion(1)] [TokenPermission(PermissionType.Publicshares_Edit)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public IActionResult List() diff --git a/API/Controller/Shares/Links/PauseShocker.cs b/API/Controller/Shares/Links/PauseShocker.cs index e720a7a09..2557115fb 100644 --- a/API/Controller/Shares/Links/PauseShocker.cs +++ b/API/Controller/Shares/Links/PauseShocker.cs @@ -3,6 +3,7 @@ using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; using OpenShock.API.Utils; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.Models; @@ -24,8 +25,9 @@ public sealed partial class ShareLinksController /// Public share or shocker does not exist /// Shocker does not exist in public share [HttpPost("{publicShareId}/{shockerId}/pause")] - [Consumes(MediaTypeNames.Application.Json)] + [ApiVersion(1)] [TokenPermission(PermissionType.Publicshares_Pause)] + [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // PublicShareNotFound, ShockerNotInPublicShare public async Task PauseShocker([FromRoute] Guid publicShareId, [FromRoute] Guid shockerId, [FromBody] PauseRequest body, CancellationToken cancellationToken) diff --git a/API/Controller/Shares/Links/RemoveShocker.cs b/API/Controller/Shares/Links/RemoveShocker.cs index 1ede1ee09..cb190867c 100644 --- a/API/Controller/Shares/Links/RemoveShocker.cs +++ b/API/Controller/Shares/Links/RemoveShocker.cs @@ -1,6 +1,7 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.Extensions; @@ -22,6 +23,7 @@ public sealed partial class ShareLinksController /// Public share or shocker does not exist /// Shocker does not exist in public share [HttpDelete("{publicShareId}/{shockerId}")] + [ApiVersion(1)] [TokenPermission(PermissionType.Publicshares_Edit)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // PublicShareNotFound, ShockerNotInPublicShare diff --git a/API/Controller/Shares/UserShares/CreateShareInvite.cs b/API/Controller/Shares/UserShares/CreateShareInvite.cs index bdcd7a392..4a4d3914e 100644 --- a/API/Controller/Shares/UserShares/CreateShareInvite.cs +++ b/API/Controller/Shares/UserShares/CreateShareInvite.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.OpenShockDb; @@ -14,12 +14,12 @@ namespace OpenShock.API.Controller.Shares.UserShares; public sealed partial class UserSharesController { [HttpPost("invites")] + [ApiVersion(2)] + [TokenPermission(PermissionType.Usershares_Edit)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Text.Plain)] - [TokenPermission(PermissionType.Usershares_Edit)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // UserNotFound, ShareCreateShockerNotFound [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // ShareCreateCannotShareWithSelf - [MapToApiVersion("2")] public async Task CreateShareInvite([FromBody] CreateShareRequest body, CancellationToken cancellationToken) { if (body.User == CurrentUser.Id) diff --git a/API/Controller/Shares/UserShares/GetShares.cs b/API/Controller/Shares/UserShares/GetShares.cs index d21e2e4aa..ddeaa83ac 100644 --- a/API/Controller/Shares/UserShares/GetShares.cs +++ b/API/Controller/Shares/UserShares/GetShares.cs @@ -1,8 +1,8 @@ -using Asp.Versioning; -using Microsoft.AspNetCore.Mvc; +using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; using OpenShock.API.Utils; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Utils; @@ -30,7 +30,7 @@ internal sealed class V2UserSharesListItemDto public sealed partial class UserSharesController { [HttpGet] - [MapToApiVersion("2")] + [ApiVersion(2)] [TokenPermission(PermissionType.Usershares_Edit)] public async Task GetSharesByUsers(CancellationToken cancellationToken) { diff --git a/API/Controller/Shares/UserShares/Invites.cs b/API/Controller/Shares/UserShares/Invites.cs index 53e253dcc..1dbd23396 100644 --- a/API/Controller/Shares/UserShares/Invites.cs +++ b/API/Controller/Shares/UserShares/Invites.cs @@ -1,12 +1,12 @@ using System.Linq.Expressions; using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; using OpenShock.API.Models.Response; using OpenShock.API.Services.DeviceUpdate; using OpenShock.API.Utils; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.Extensions; @@ -60,8 +60,8 @@ file static class QueryHelper public sealed partial class UserSharesController { [HttpGet("invites/outgoing")] + [ApiVersion(2)] [TokenPermission(PermissionType.Usershares_Edit)] - [MapToApiVersion("2")] public IAsyncEnumerable GetOutgoingInvitesList() { return _db.UserShareInvites @@ -71,8 +71,8 @@ public IAsyncEnumerable GetOutgoingInvitesList() } [HttpGet("invites/incoming")] + [ApiVersion(2)] [TokenPermission(PermissionType.Usershares_Edit)] - [MapToApiVersion("2")] public IAsyncEnumerable GetIncomingInvitesList() { return _db.UserShareInvites @@ -82,10 +82,10 @@ public IAsyncEnumerable GetIncomingInvitesList() } [HttpDelete("invites/outgoing/{inviteId}")] + [ApiVersion(2)] + [TokenPermission(PermissionType.Usershares_Edit)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShareRequestNotFound - [TokenPermission(PermissionType.Usershares_Edit)] - [MapToApiVersion("2")] public async Task DeleteOutgoingInvite([FromRoute] Guid inviteId, CancellationToken cancellationToken) { var deletedShareRequest = await _db.UserShareInvites @@ -97,10 +97,10 @@ public async Task DeleteOutgoingInvite([FromRoute] Guid inviteId, } [HttpDelete("invites/incoming/{inviteId}")] + [ApiVersion(2)] + [TokenPermission(PermissionType.Usershares_Edit)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShareRequestNotFound - [TokenPermission(PermissionType.Usershares_Edit)] - [MapToApiVersion("2")] public async Task DenyIncomingInvite([FromRoute] Guid inviteId, CancellationToken cancellationToken) { var deletedShareRequest = await _db.UserShareInvites @@ -117,12 +117,11 @@ public async Task DenyIncomingInvite([FromRoute] Guid inviteId, C /// /// /// - /// [HttpPost("invites/incoming/{inviteId}")] + [ApiVersion(2)] + [TokenPermission(PermissionType.Usershares_Edit)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShareRequestNotFound - [TokenPermission(PermissionType.Usershares_Edit)] - [MapToApiVersion("2")] public async Task RedeemInvite([FromRoute] Guid inviteId, [FromServices] IDeviceUpdateService deviceUpdateService, CancellationToken cancellationToken) { var shareRequest = await _db.UserShareInvites diff --git a/API/Controller/Shares/UserShares/PauseShockerShares.cs b/API/Controller/Shares/UserShares/PauseShockerShares.cs index 7b2309060..2ec5714d6 100644 --- a/API/Controller/Shares/UserShares/PauseShockerShares.cs +++ b/API/Controller/Shares/UserShares/PauseShockerShares.cs @@ -1,9 +1,9 @@ using System.ComponentModel.DataAnnotations; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Services.DeviceUpdate; using OpenShock.API.Utils; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.Models; @@ -14,8 +14,8 @@ namespace OpenShock.API.Controller.Shares.UserShares; public sealed partial class UserSharesController { [HttpPost("{userId:guid}/shockers/pause")] + [ApiVersion(2)] [TokenPermission(PermissionType.Usershares_Pause)] - [MapToApiVersion("2")] [ProducesResponseType(StatusCodes.Status200OK)] public async Task BulkPauseUserShareShockers( [FromRoute] Guid userId, diff --git a/API/Controller/Shares/UserShares/RemoveShockerShares.cs b/API/Controller/Shares/UserShares/RemoveShockerShares.cs index b34950b33..e891e55bf 100644 --- a/API/Controller/Shares/UserShares/RemoveShockerShares.cs +++ b/API/Controller/Shares/UserShares/RemoveShockerShares.cs @@ -1,8 +1,8 @@ using System.ComponentModel.DataAnnotations; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Services.DeviceUpdate; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.Models; @@ -13,7 +13,7 @@ namespace OpenShock.API.Controller.Shares.UserShares; public sealed partial class UserSharesController { [HttpDelete("{userId:guid}/shockers")] - [MapToApiVersion("2")] + [ApiVersion(2)] [TokenPermission(PermissionType.Shockers_Edit)] [ProducesResponseType(StatusCodes.Status200OK)] public async Task BulkRemoveUserShareShockers([FromRoute] Guid userId , [FromBody] [MinLength(1)] Guid[] shockerIds, [FromServices] IDeviceUpdateService deviceUpdateService, CancellationToken cancellationToken) diff --git a/API/Controller/Shares/UserShares/UpdateShockerShares.cs b/API/Controller/Shares/UserShares/UpdateShockerShares.cs index 3c1f7dea1..ebca03f3a 100644 --- a/API/Controller/Shares/UserShares/UpdateShockerShares.cs +++ b/API/Controller/Shares/UserShares/UpdateShockerShares.cs @@ -1,9 +1,9 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; using OpenShock.API.Services.DeviceUpdate; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.Models; @@ -24,12 +24,12 @@ public sealed partial class UserSharesController /// Successfully updated share code /// The share code does not exist or you do not have access to it. [HttpPatch("{userId:guid}/shockers")] + [ApiVersion(2)] [TokenPermission(PermissionType.Shockers_Edit)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("2")] public async Task BulkUserShareShockersUpdate( [FromRoute] Guid userId, [FromBody] BulkUserShareShockersUpdateRequest body, diff --git a/API/Controller/Shares/UserShares/_ApiController.cs b/API/Controller/Shares/UserShares/_ApiController.cs index 1f7116045..f8aa80fbc 100644 --- a/API/Controller/Shares/UserShares/_ApiController.cs +++ b/API/Controller/Shares/UserShares/_ApiController.cs @@ -1,5 +1,4 @@ -using Asp.Versioning; -using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using OpenShock.Common.Authentication; using OpenShock.Common.Authentication.ControllerBase; @@ -12,7 +11,6 @@ namespace OpenShock.API.Controller.Shares.UserShares; /// [ApiController] [Tags("User Shocker Shares")] -[ApiVersion("2")] [Route("/{version:apiVersion}/shares/user")] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.UserSessionApiTokenCombo)] public sealed partial class UserSharesController : AuthenticatedSessionControllerBase diff --git a/API/Controller/Shares/_ApiController.cs b/API/Controller/Shares/_ApiController.cs index ad80dd274..4a289d9d8 100644 --- a/API/Controller/Shares/_ApiController.cs +++ b/API/Controller/Shares/_ApiController.cs @@ -1,5 +1,4 @@ -using Asp.Versioning; -using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using OpenShock.Common.Authentication; using OpenShock.Common.Authentication.ControllerBase; @@ -12,7 +11,6 @@ namespace OpenShock.API.Controller.Shares; /// [ApiController] [Tags("Shocker Shares")] -[ApiVersion("1"), ApiVersion("2")] [Route("/{version:apiVersion}/shares")] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.UserSessionCookie)] public sealed partial class SharesController : AuthenticatedSessionControllerBase diff --git a/API/Controller/Shockers/EditShocker.cs b/API/Controller/Shockers/EditShocker.cs index 3b44bf5d8..563772991 100644 --- a/API/Controller/Shockers/EditShocker.cs +++ b/API/Controller/Shockers/EditShocker.cs @@ -1,9 +1,9 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; using OpenShock.API.Services.DeviceUpdate; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.Models; @@ -24,11 +24,11 @@ public sealed partial class ShockerController /// Successfully updated shocker /// Shocker does not exist [HttpPatch("{shockerId}")] + [ApiVersion(1)] [TokenPermission(PermissionType.Shockers_Edit)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound, ShockerNotFound - [MapToApiVersion("1")] public async Task EditShocker( [FromRoute] Guid shockerId, [FromBody] NewShocker body, diff --git a/API/Controller/Shockers/GetShockerById.cs b/API/Controller/Shockers/GetShockerById.cs index 1b827f29a..8dc9dcabd 100644 --- a/API/Controller/Shockers/GetShockerById.cs +++ b/API/Controller/Shockers/GetShockerById.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Models; using OpenShock.Internal.Common.Problems; @@ -19,9 +19,9 @@ public sealed partial class ShockerController /// The shocker information was successfully retrieved. /// The shocker does not exist or you do not have access to it. [HttpGet("{shockerId}")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] public async Task GetShockerById([FromRoute] Guid shockerId, CancellationToken cancellationToken) { var shocker = await _db.Shockers.Where(x => x.Device.OwnerId == CurrentUser.Id && x.Id == shockerId).Select(x => new ShockerWithDevice diff --git a/API/Controller/Shockers/GetShockerLogs.cs b/API/Controller/Shockers/GetShockerLogs.cs index 819920e03..9236a3c2a 100644 --- a/API/Controller/Shockers/GetShockerLogs.cs +++ b/API/Controller/Shockers/GetShockerLogs.cs @@ -1,10 +1,10 @@ using System.ComponentModel.DataAnnotations; using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Extensions; using OpenShock.Common.Models; @@ -40,10 +40,10 @@ public sealed partial class ShockerController /// The logs /// Shocker does not exist [HttpGet("{shockerId}/logs")] + [ApiVersion(1)] [EnableRateLimiting("shocker-logs")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] public async Task GetShockerLogs([FromRoute] Guid shockerId, [FromQuery(Name = "offset")] uint offset = 0, [FromQuery, Range(1, 500)] uint limit = 100, CancellationToken cancellationToken = default) @@ -93,9 +93,9 @@ public async Task GetShockerLogs([FromRoute] Guid shockerId, [Fro /// /// A page of logs. [HttpGet("logs")] + [ApiVersion(1)] [EnableRateLimiting("shocker-logs")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] - [MapToApiVersion("1")] public async Task> GetAllShockerLogs( [FromQuery] PaginationQuery pagination, [FromQuery(Name = "shockerIds")] Guid[]? shockerIds, diff --git a/API/Controller/Shockers/ListSharedShockers.cs b/API/Controller/Shockers/ListSharedShockers.cs index dff9edef3..ad6a01276 100644 --- a/API/Controller/Shockers/ListSharedShockers.cs +++ b/API/Controller/Shockers/ListSharedShockers.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Models; using OpenShock.Common.Utils; @@ -25,7 +25,7 @@ public sealed partial class ShockerController /// /// The shockers were successfully retrieved. [HttpGet("shared")] - [MapToApiVersion("1")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task ListSharedShockers(CancellationToken cancellationToken) { diff --git a/API/Controller/Shockers/ListShockers.cs b/API/Controller/Shockers/ListShockers.cs index aa27c1320..5b70d510b 100644 --- a/API/Controller/Shockers/ListShockers.cs +++ b/API/Controller/Shockers/ListShockers.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Models; namespace OpenShock.API.Controller.Shockers; @@ -14,7 +14,7 @@ public sealed partial class ShockerController /// /// The shockers were successfully retrieved. [HttpGet("own")] - [MapToApiVersion("1")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public IActionResult ListShockers() { diff --git a/API/Controller/Shockers/PauseShocker.cs b/API/Controller/Shockers/PauseShocker.cs index 9b2d1b4d2..a8d7ae1b4 100644 --- a/API/Controller/Shockers/PauseShocker.cs +++ b/API/Controller/Shockers/PauseShocker.cs @@ -1,9 +1,9 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; using OpenShock.API.Services.DeviceUpdate; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.Models; @@ -24,11 +24,11 @@ public sealed partial class ShockerController /// Successfully set pause state /// Shocker not found or does not belong to you [HttpPost("{shockerId}/pause")] + [ApiVersion(1)] [TokenPermission(PermissionType.Shockers_Pause)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] public async Task PauseShocker([FromRoute] Guid shockerId, [FromBody] PauseRequest body, [FromServices] IDeviceUpdateService deviceUpdateService, CancellationToken cancellationToken) diff --git a/API/Controller/Shockers/RegisterShocker.cs b/API/Controller/Shockers/RegisterShocker.cs index 9fd04d07a..4c22fd848 100644 --- a/API/Controller/Shockers/RegisterShocker.cs +++ b/API/Controller/Shockers/RegisterShocker.cs @@ -1,9 +1,9 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; using OpenShock.API.Services.DeviceUpdate; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.Models; @@ -22,12 +22,12 @@ public sealed partial class ShockerController /// You can have a maximum of 11 Shockers per Device. /// Device does not exist [HttpPost] - [ProducesResponseType>(StatusCodes.Status201Created, MediaTypeNames.Application.Json)] + [ApiVersion(1)] [TokenPermission(PermissionType.Shockers_Edit)] [Consumes(MediaTypeNames.Application.Json)] + [ProducesResponseType>(StatusCodes.Status201Created, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // TooManyShockers - [MapToApiVersion("1")] public async Task RegisterShocker( [FromBody] NewShocker body, [FromServices] IDeviceUpdateService deviceUpdateService, diff --git a/API/Controller/Shockers/RemoveShocker.cs b/API/Controller/Shockers/RemoveShocker.cs index 3460a1fb6..fd9861e1e 100644 --- a/API/Controller/Shockers/RemoveShocker.cs +++ b/API/Controller/Shockers/RemoveShocker.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Services.DeviceUpdate; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.Extensions; @@ -23,10 +23,10 @@ public sealed partial class ShockerController /// Successfully deleted shocker /// Shocker does not exist [HttpDelete("{shockerId}")] + [ApiVersion(1)] [TokenPermission(PermissionType.Shockers_Edit)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] public async Task RemoveShocker( [FromRoute] Guid shockerId, [FromServices] IDeviceUpdateService deviceUpdateService, diff --git a/API/Controller/Shockers/SendControl.cs b/API/Controller/Shockers/SendControl.cs index 9b9c5fbb9..2f6f03113 100644 --- a/API/Controller/Shockers/SendControl.cs +++ b/API/Controller/Shockers/SendControl.cs @@ -1,5 +1,5 @@ using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.SignalR; using OpenShock.Common.Authentication.Attributes; @@ -21,8 +21,8 @@ public sealed partial class ShockerController /// Send a control message to shockers /// /// The control messages were successfully sent. - [MapToApiVersion("2")] [HttpPost("control")] + [ApiVersion(2)] [TokenPermission(PermissionType.Shockers_Use)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] @@ -68,8 +68,8 @@ public async Task SendControl( /// Send a control message to shockers (Deprecated in favor of the /2/shockers/control endpoint) /// /// The control messages were successfully sent. - [MapToApiVersion("1")] [HttpPost("control")] + [ApiVersion(1)] [TokenPermission(PermissionType.Shockers_Use)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] diff --git a/API/Controller/Shockers/ShockerShares.cs b/API/Controller/Shockers/ShockerShares.cs index e30486f0b..94c5e7b92 100644 --- a/API/Controller/Shockers/ShockerShares.cs +++ b/API/Controller/Shockers/ShockerShares.cs @@ -1,10 +1,10 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; using OpenShock.API.Models.Response; using OpenShock.API.Services.DeviceUpdate; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.Extensions; @@ -24,9 +24,9 @@ public sealed partial class ShockerController /// OK /// The shocker does not exist or you do not have access to it. [HttpGet("{shockerId}/shares")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] public async Task GetUserShares([FromRoute] Guid shockerId, CancellationToken cancellationToken) { var owns = await _db.Shockers.AnyAsync(x => x.Device.OwnerId == CurrentUser.Id && x.Id == shockerId, cancellationToken); @@ -71,9 +71,9 @@ public async Task GetUserShares([FromRoute] Guid shockerId, Cance /// /// OK [HttpGet("{shockerId}/shareCodes")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] public async Task ShockerShareCodeList([FromRoute] Guid shockerId, CancellationToken cancellationToken) { var owns = await _db.Shockers.AnyAsync(x => x.Device.OwnerId == CurrentUser.Id && x.Id == shockerId, cancellationToken); @@ -106,13 +106,12 @@ public sealed class ShareCodeInfo /// /// The share code was successfully created. /// Shocker does not exists or you do not have access to it. - /// [HttpPost("{shockerId}/shares")] + [ApiVersion(1)] [TokenPermission(PermissionType.Shockers_Edit)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] public async Task ShockerShareCodeCreate( [FromRoute] Guid shockerId, [FromBody] ShockerPermLimitPair body, @@ -153,10 +152,10 @@ CancellationToken cancellationToken /// Successfully removed share code /// Share does not exists or device/shocker does not belong to you nor is shared with you [HttpDelete("{shockerId}/shares/{sharedWithUserId}")] + [ApiVersion(1)] [TokenPermission(PermissionType.Shockers_Edit)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] public async Task ShockerShareRemove( [FromRoute] Guid shockerId, [FromRoute] Guid sharedWithUserId, @@ -188,11 +187,11 @@ public async Task ShockerShareRemove( /// Successfully updated share code /// The share code does not exist or you do not have access to it. [HttpPatch("{shockerId}/shares/{sharedWithUserId}")] + [ApiVersion(1)] [TokenPermission(PermissionType.Shockers_Edit)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] public async Task ShockerShareCodeUpdate( [FromRoute] Guid shockerId, [FromRoute] Guid sharedWithUserId, @@ -234,11 +233,11 @@ public async Task ShockerShareCodeUpdate( /// Successfully updated pause status share /// The share code does not exist or you do not have access to it. [HttpPost("{shockerId}/shares/{sharedWithUserId}/pause")] + [ApiVersion(1)] [TokenPermission(PermissionType.Shockers_Pause)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] public async Task ShockerShareCodePause( [FromRoute] Guid shockerId, [FromRoute] Guid sharedWithUserId, diff --git a/API/Controller/Shockers/_ApiController.cs b/API/Controller/Shockers/_ApiController.cs index d24f938a9..731195213 100644 --- a/API/Controller/Shockers/_ApiController.cs +++ b/API/Controller/Shockers/_ApiController.cs @@ -1,5 +1,4 @@ -using Asp.Versioning; -using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using OpenShock.Common.Authentication; using OpenShock.Common.Authentication.ControllerBase; @@ -12,7 +11,6 @@ namespace OpenShock.API.Controller.Shockers; /// [ApiController] [Tags("Shockers")] -[ApiVersion("1"), ApiVersion("2")] [Route("/{version:apiVersion}/shockers")] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.UserSessionApiTokenCombo)] public sealed partial class ShockerController : AuthenticatedSessionControllerBase diff --git a/API/Controller/Tokens/DeleteToken.cs b/API/Controller/Tokens/DeleteToken.cs index ffc782b29..d78ba108d 100644 --- a/API/Controller/Tokens/DeleteToken.cs +++ b/API/Controller/Tokens/DeleteToken.cs @@ -3,6 +3,7 @@ using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Services.Token; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication; using OpenShock.Common.Authentication.ControllerBase; using OpenShock.Common.Errors; @@ -35,6 +36,7 @@ public TokenDeleteController(IApiTokenService tokenService, ILoggerApi Token is not allowed to delete other Api Tokens /// The token does not exist, or you do not have access to it [HttpDelete("{tokenId}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status403Forbidden)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ApiTokenNotFound diff --git a/API/Controller/Tokens/GetTokenSelf.cs b/API/Controller/Tokens/GetTokenSelf.cs index e3118b957..46462dcbe 100644 --- a/API/Controller/Tokens/GetTokenSelf.cs +++ b/API/Controller/Tokens/GetTokenSelf.cs @@ -1,8 +1,8 @@ -using Asp.Versioning; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication; using OpenShock.Common.Authentication.ControllerBase; using OpenShock.Common.OpenShockDb; @@ -13,16 +13,14 @@ namespace OpenShock.API.Controller.Tokens; [Tags("API Tokens")] [Route("/{version:apiVersion}/tokens")] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.ApiToken)] -[ApiVersion("1"), ApiVersion("2")] public sealed partial class TokensSelfController : AuthenticatedSessionControllerBase { /// /// Gets information about the current token used to access this endpoint /// - /// /// [HttpGet("self")] - [MapToApiVersion("1")] + [ApiVersion(1)] public TokenResponse GetSelfToken() { return TokenResponse.MapFrom(GetSelfTokenV2()); @@ -31,9 +29,8 @@ public TokenResponse GetSelfToken() /// /// Gets information about the current token used to access this endpoint /// - /// [HttpGet("self")] - [MapToApiVersion("2")] + [ApiVersion(2)] public TokenResponseV2 GetSelfTokenV2() { var token = GetRequiredItem(); diff --git a/API/Controller/Tokens/ReportTokens.cs b/API/Controller/Tokens/ReportTokens.cs index ec5217329..6126cc2b1 100644 --- a/API/Controller/Tokens/ReportTokens.cs +++ b/API/Controller/Tokens/ReportTokens.cs @@ -7,11 +7,13 @@ using OpenShock.API.Errors; using OpenShock.API.Models.Requests; using OpenShock.API.Services.Turnstile; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Services.AutomationTokens; using OpenShock.Common.Services.Webhook; using OpenShock.Common.Utils; using OpenShock.Internal.Common.Problems; +using OpenShock.Internal.Common.Utils; namespace OpenShock.API.Controller.Tokens; @@ -27,6 +29,7 @@ public sealed partial class TokensController /// /// The tokens were deleted if found [HttpPost("report")] + [ApiVersion(1)] [EnableRateLimiting("token-reporting")] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] diff --git a/API/Controller/Tokens/Tokens.cs b/API/Controller/Tokens/Tokens.cs index 9ba6a2175..af7981988 100644 --- a/API/Controller/Tokens/Tokens.cs +++ b/API/Controller/Tokens/Tokens.cs @@ -1,9 +1,9 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Requests; using OpenShock.API.Models.Response; using OpenShock.API.Services.Token; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Utils; using OpenShock.Internal.Common.Problems; @@ -17,7 +17,7 @@ public sealed partial class TokensController /// /// All tokens for the current user [HttpGet] - [MapToApiVersion("1")] + [ApiVersion(1)] public IAsyncEnumerable ListTokens([FromServices] IApiTokenService tokenService, CancellationToken cancellationToken) { return tokenService.ListTokensV1(ownerId: CurrentUser.Id, cancellationToken: cancellationToken); @@ -28,7 +28,7 @@ public IAsyncEnumerable ListTokens([FromServices] IApiTokenServic /// /// All tokens for the current user [HttpGet] - [MapToApiVersion("2")] + [ApiVersion(2)] public IAsyncEnumerable ListTokensV2([FromServices] IApiTokenService tokenService, CancellationToken cancellationToken) { return tokenService.ListTokensV2(ownerId: CurrentUser.Id, cancellationToken: cancellationToken); @@ -43,9 +43,9 @@ public IAsyncEnumerable ListTokensV2([FromServices] IApiTokenSe /// The token /// The token does not exist or you do not have access to it. [HttpGet("{tokenId}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ApiTokenNotFound - [MapToApiVersion("1")] public async Task GetTokenById([FromRoute] Guid tokenId, [FromServices] IApiTokenService tokenService, CancellationToken cancellationToken) { var apiToken = await tokenService.GetTokenV1(tokenId, CurrentUser.Id, cancellationToken); @@ -63,9 +63,9 @@ public async Task GetTokenById([FromRoute] Guid tokenId, [FromSer /// The token /// The token does not exist or you do not have access to it. [HttpGet("{tokenId}")] + [ApiVersion(2)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ApiTokenNotFound - [MapToApiVersion("2")] public async Task GetTokenByIdV2([FromRoute] Guid tokenId, [FromServices] IApiTokenService tokenService, CancellationToken cancellationToken) { var apiToken = await tokenService.GetTokenV2(tokenId, CurrentUser.Id, cancellationToken); @@ -82,9 +82,9 @@ public async Task GetTokenByIdV2([FromRoute] Guid tokenId, [FromS /// /// The created token [HttpPost] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [Produces(MediaTypeNames.Application.Json)] - [MapToApiVersion("1")] public Task CreateToken( [FromBody] CreateTokenRequest body, [FromServices] IApiTokenService tokenService, @@ -103,10 +103,10 @@ public Task CreateToken( /// The edited token /// The token does not exist or you do not have access to it. [HttpPatch("{tokenId}")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ApiTokenNotFound - [MapToApiVersion("1")] public async Task EditToken([FromRoute] Guid tokenId, [FromBody] EditTokenRequest body, [FromServices] IApiTokenService tokenService, CancellationToken cancellationToken) { if (!await tokenService.EditTokenV1(tokenId, body, CurrentUser.Id, cancellationToken)) return Problem(ApiTokenError.ApiTokenNotFound); @@ -122,9 +122,9 @@ public async Task EditToken([FromRoute] Guid tokenId, [FromBody] /// /// The created token [HttpPost] + [ApiVersion(2)] [Consumes(MediaTypeNames.Application.Json)] [Produces(MediaTypeNames.Application.Json)] - [MapToApiVersion("2")] public Task CreateTokenV2( [FromBody] CreateTokenRequestV2 body, [FromServices] IApiTokenService tokenService, @@ -143,10 +143,10 @@ public Task CreateTokenV2( /// The edited token /// The token does not exist or you do not have access to it. [HttpPatch("{tokenId}")] + [ApiVersion(2)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ApiTokenNotFound - [MapToApiVersion("2")] public async Task EditTokenV2([FromRoute] Guid tokenId, [FromBody] EditTokenRequestV2 body, [FromServices] IApiTokenService tokenService, CancellationToken cancellationToken) { if (!await tokenService.EditTokenV2(tokenId, body, CurrentUser.Id, cancellationToken)) return Problem(ApiTokenError.ApiTokenNotFound); @@ -164,10 +164,10 @@ public async Task EditTokenV2([FromRoute] Guid tokenId, [FromBody /// The now-set paused state of the token. /// The token does not exist or you do not have access to it. [HttpPatch("{tokenId}/paused")] + [ApiVersion(2)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ApiTokenNotFound - [MapToApiVersion("2")] public async Task SetTokenPaused([FromRoute] Guid tokenId, [FromBody] SetTokenPausedRequest body, [FromServices] IApiTokenService tokenService, CancellationToken cancellationToken) { var paused = await tokenService.SetTokenPaused(tokenId, body.Paused, CurrentUser.Id, cancellationToken); diff --git a/API/Controller/Tokens/_ApiController.cs b/API/Controller/Tokens/_ApiController.cs index 5d99a12f9..77033eab9 100644 --- a/API/Controller/Tokens/_ApiController.cs +++ b/API/Controller/Tokens/_ApiController.cs @@ -1,5 +1,4 @@ -using Asp.Versioning; -using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using OpenShock.Common.Authentication; using OpenShock.Common.Authentication.ControllerBase; @@ -11,7 +10,6 @@ namespace OpenShock.API.Controller.Tokens; [Tags("API Tokens")] [Route("/{version:apiVersion}/tokens")] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.UserSessionCookie)] -[ApiVersion("1"), ApiVersion("2")] public sealed partial class TokensController : AuthenticatedSessionControllerBase { private readonly OpenShockContext _db; diff --git a/API/Controller/Users/GetSelf.cs b/API/Controller/Users/GetSelf.cs index fcfaa7472..5e3c3146b 100644 --- a/API/Controller/Users/GetSelf.cs +++ b/API/Controller/Users/GetSelf.cs @@ -1,6 +1,7 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Extensions; using OpenShock.Common.Models; @@ -14,6 +15,7 @@ public sealed partial class UsersController /// The user's information was successfully retrieved. [Obsolete("Use GET /1/account instead.")] [HttpGet("self")] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public IActionResult GetSelf() { diff --git a/API/Controller/Users/GetSelfControlStats.cs b/API/Controller/Users/GetSelfControlStats.cs index cecbddd7d..e664fd4d0 100644 --- a/API/Controller/Users/GetSelfControlStats.cs +++ b/API/Controller/Users/GetSelfControlStats.cs @@ -6,6 +6,7 @@ using Npgsql; using OpenShock.API.Errors; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Models; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Utils; @@ -25,6 +26,7 @@ public sealed partial class UsersController /// The statistics. /// Unknown time zone or invalid range. [HttpGet("self/control-stats")] + [ApiVersion(1)] [EnableRateLimiting("control-stats")] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // InvalidTimeZone, InvalidRange diff --git a/API/Controller/Users/LookupByName.cs b/API/Controller/Users/LookupByName.cs index db61d4680..478ddc5bb 100644 --- a/API/Controller/Users/LookupByName.cs +++ b/API/Controller/Users/LookupByName.cs @@ -1,6 +1,7 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Services.UserService; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Models; using OpenShock.Internal.Common.Problems; @@ -10,6 +11,7 @@ namespace OpenShock.API.Controller.Users; public sealed partial class UsersController { [HttpGet("by-name/{username}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] public async Task GetByName([FromRoute] string username, [FromServices] IUserService userService, CancellationToken cancellationToken) diff --git a/API/Controller/Version/_ApiController.cs b/API/Controller/Version/_ApiController.cs index c3fb12c12..93fde37aa 100644 --- a/API/Controller/Version/_ApiController.cs +++ b/API/Controller/Version/_ApiController.cs @@ -5,6 +5,7 @@ using OpenShock.API.OAuth; using OpenShock.API.Options; using OpenShock.Common; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Extensions; using OpenShock.Common.Models; using OpenShock.Common.Options; @@ -39,6 +40,7 @@ private static string GetBackendVersion() /// /// The version was successfully retrieved. [HttpGet] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task GetBackendInfo( [FromServices] IAuthenticationSchemeProvider schemeProvider, diff --git a/API/Program.cs b/API/Program.cs index dd6aa37a2..1afa88147 100644 --- a/API/Program.cs +++ b/API/Program.cs @@ -123,6 +123,9 @@ static void DefaultOptions(RemoteAuthenticationOptions options, string provider) }) .AddOpenShockSignalR(redisOptions); +// XML documentation comments are applied by a source generator that intercepts this call, so it has to be made here in the host +builder.Services.AddOpenApi(OpenShockServiceHelper.OpenApiDocumentName, OpenShockServiceHelper.ConfigureOpenApi); + builder.Services.AddScoped(); builder.Services.AddScoped(); builder.Services.AddScoped(); diff --git a/Common/ApiVersioning/ApiVersionAttribute.cs b/Common/ApiVersioning/ApiVersionAttribute.cs new file mode 100644 index 000000000..71232b851 --- /dev/null +++ b/Common/ApiVersioning/ApiVersionAttribute.cs @@ -0,0 +1,23 @@ +namespace OpenShock.Common.ApiVersioning; + +/// +/// The API version an action is served under, filled into the {version:apiVersion} placeholder of its route: +/// [HttpPost("login")] on a controller routed at /{version:apiVersion}/account with [ApiVersion(2)] serves /2/account/login. +/// +/// +/// Belongs on the action method. On a controller it applies to all of that controller's actions, which is only meant for controllers whose +/// actions are inherited (the websocket controllers); an attribute on the method takes precedence. An action without a version is not +/// versioned, and its route may not contain the placeholder. See . +/// +[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, Inherited = true)] +public sealed class ApiVersionAttribute : Attribute +{ + public ApiVersionAttribute(uint version) + { + ArgumentOutOfRangeException.ThrowIfZero(version); + + Version = version; + } + + public uint Version { get; } +} diff --git a/Common/ApiVersioning/ApiVersionRouteConvention.cs b/Common/ApiVersioning/ApiVersionRouteConvention.cs new file mode 100644 index 000000000..7ccf31d97 --- /dev/null +++ b/Common/ApiVersioning/ApiVersionRouteConvention.cs @@ -0,0 +1,70 @@ +using System.Reflection; +using Microsoft.AspNetCore.Mvc.ApplicationModels; + +namespace OpenShock.Common.ApiVersioning; + +/// +/// Fills the {version:apiVersion} placeholder in the full route (controller route included) of every action with +/// , taken from the action method or else its controller: /{version:apiVersion}/account + login with [ApiVersion(1)] becomes /1/account/login. +/// +/// +/// The placeholder and the attribute go together: a versioned action whose route has no placeholder, or a placeholder on an action +/// without a version, fails at startup. +/// +public sealed class ApiVersionRouteConvention : IApplicationModelConvention +{ + public const string Placeholder = "{version:apiVersion}"; + + public void Apply(ApplicationModel application) + { + foreach (var controller in application.Controllers) + { + var controllerRoutes = controller.Selectors.Select(s => s.AttributeRouteModel).OfType().ToArray(); + + foreach (var action in controller.Actions) + { + var version = (action.ActionMethod.GetCustomAttribute(inherit: true) + ?? controller.ControllerType.GetCustomAttribute(inherit: true))?.Version; + + var selectors = action.Selectors.SelectMany(selector => Version(action, selector, controllerRoutes, version)).ToArray(); + + action.Selectors.Clear(); + foreach (var selector in selectors) action.Selectors.Add(selector); + } + } + } + + private static IEnumerable Version(ActionModel action, SelectorModel selector, AttributeRouteModel[] controllerRoutes, uint? version) + { + // The route the action ends up with: its own when absolute (or when the controller has none), otherwise combined with the controller's + var routes = selector.AttributeRouteModel is { IsAbsoluteTemplate: true } || controllerRoutes.Length == 0 + ? [selector.AttributeRouteModel] + : controllerRoutes.Select(controllerRoute => AttributeRouteModel.CombineAttributeRouteModel(controllerRoute, selector.AttributeRouteModel)); + + if (version is null) + { + if (routes.Any(route => HasPlaceholder(route?.Template))) + throw new InvalidOperationException($"{action.DisplayName} has {Placeholder} in its route but no {nameof(ApiVersionAttribute)}"); + + yield return selector; + yield break; + } + + foreach (var route in routes) + { + if (route is null || !HasPlaceholder(route.Template)) + throw new InvalidOperationException($"{action.DisplayName} has an {nameof(ApiVersionAttribute)} but no {Placeholder} in its route"); + + // Absolute, so it is no longer combined with the controller's route + yield return new SelectorModel(selector) + { + AttributeRouteModel = new AttributeRouteModel(route) + { + Template = "/" + route.Template!.TrimStart('~', '/').Replace(Placeholder, version.Value.ToString(), StringComparison.OrdinalIgnoreCase) + } + }; + } + } + + private static bool HasPlaceholder(string? template) => template?.Contains(Placeholder, StringComparison.OrdinalIgnoreCase) ?? false; +} diff --git a/Common/Common.csproj b/Common/Common.csproj index 512bb787b..5469b1ed0 100644 --- a/Common/Common.csproj +++ b/Common/Common.csproj @@ -39,8 +39,6 @@ - - diff --git a/Common/OpenApi/ControllerTagDescriptionTransformer.cs b/Common/OpenApi/ControllerTagDescriptionTransformer.cs deleted file mode 100644 index 2fea1d03e..000000000 --- a/Common/OpenApi/ControllerTagDescriptionTransformer.cs +++ /dev/null @@ -1,51 +0,0 @@ -using Microsoft.AspNetCore.Http.Metadata; -using Microsoft.AspNetCore.Mvc.Controllers; -using Microsoft.AspNetCore.OpenApi; -using Microsoft.OpenApi; - -namespace OpenShock.Common.OpenApi; - -/// -/// Restores controller class <summary> text as top-level tag descriptions, -/// which the built-in XML comment support does not do. -/// -public sealed class ControllerTagDescriptionTransformer(DocumentedXmlComments comments) : IOpenApiDocumentTransformer -{ - public Task TransformAsync(OpenApiDocument document, OpenApiDocumentTransformerContext context, CancellationToken cancellationToken) - { - var descriptions = new Dictionary(); - - foreach (var description in context.DescriptionGroups.SelectMany(g => g.Items)) - { - if (description.ActionDescriptor is not ControllerActionDescriptor controller) continue; - - var summary = comments.GetSummary(controller.ControllerTypeInfo); - if (summary.Length == 0) continue; - - // Operations are tagged by [Tags] when present, otherwise by controller name - var tagNames = controller.EndpointMetadata.OfType().SelectMany(t => t.Tags).ToArray(); - if (tagNames.Length == 0) tagNames = [controller.ControllerName]; - - foreach (var tagName in tagNames) - { - descriptions.TryAdd(tagName, summary); - } - } - - var tags = new SortedDictionary(StringComparer.Ordinal); - foreach (var tag in document.Tags ?? Enumerable.Empty()) - { - if (tag.Name is not null) tags.TryAdd(tag.Name, tag); - } - - // Only describe tags operations actually use (or that already exist); never invent new ones - foreach (var (name, summary) in descriptions) - { - if (tags.TryGetValue(name, out var existing)) existing.Description ??= summary; - } - - document.Tags = new HashSet(tags.Values); - - return Task.CompletedTask; - } -} diff --git a/Common/OpenApi/DocumentedResponsesTransformer.cs b/Common/OpenApi/DocumentedResponsesTransformer.cs deleted file mode 100644 index 1f386b0c8..000000000 --- a/Common/OpenApi/DocumentedResponsesTransformer.cs +++ /dev/null @@ -1,40 +0,0 @@ -using Microsoft.AspNetCore.Mvc.Controllers; -using Microsoft.AspNetCore.OpenApi; -using Microsoft.OpenApi; - -namespace OpenShock.Common.OpenApi; - -/// -/// Restores <response code="..."> XML docs as responses, including codes that have no [ProducesResponseType], -/// which the built-in XML comment support leaves out. -/// -public sealed class DocumentedResponsesTransformer(DocumentedXmlComments comments) : IOpenApiOperationTransformer -{ - public Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransformerContext context, CancellationToken cancellationToken) - { - if (context.Description.ActionDescriptor is not ControllerActionDescriptor { MethodInfo: var method }) return Task.CompletedTask; - - var codes = comments.FindMember(method)?.Elements("response").Select(r => r.Attribute("code")?.Value); - if (codes is null) return Task.CompletedTask; - - foreach (var code in codes) - { - if (string.IsNullOrEmpty(code)) continue; - - var description = comments.GetResponseDescription(method, code); - if (description.Length == 0) continue; - - operation.Responses ??= new OpenApiResponses(); - if (operation.Responses.TryGetValue(code, out var existing)) - { - if (existing is OpenApiResponse response) response.Description = description; - } - else - { - operation.Responses[code] = new OpenApiResponse { Description = description }; - } - } - - return Task.CompletedTask; - } -} diff --git a/Common/OpenApi/OpenShockOperationTransformer.cs b/Common/OpenApi/OpenShockOperationTransformer.cs index f73b2741e..b96b682fd 100644 --- a/Common/OpenApi/OpenShockOperationTransformer.cs +++ b/Common/OpenApi/OpenShockOperationTransformer.cs @@ -52,9 +52,9 @@ public Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransform if (attributes.Length != 0) { - if (attributes.Count(attr => !string.IsNullOrEmpty(attr.AuthenticationSchemes)) > 1) throw new Exception("Dunno what to apply to this method (multiple authentication attributes with schemes set)"); - - var scheme = attributes.Select(attr => attr.AuthenticationSchemes).SingleOrDefault(s => !string.IsNullOrEmpty(s)); + // Stacked [Authorize] attributes combine into one policy that accepts the union of their schemes + var schemes = attributes.Select(attr => attr.AuthenticationSchemes).Where(s => !string.IsNullOrEmpty(s)).SelectMany(s => s!.Split(',')).Select(s => s.Trim()).Distinct().ToArray(); + var scheme = schemes.Length > 0 ? string.Join(',', schemes) : null; var roles = attributes.Select(attr => attr.Roles).Where(r => !string.IsNullOrEmpty(r)).SelectMany(r => r!.Split(',')).Select(r => r.Trim()).ToArray(); var policies = attributes.Select(attr => attr.Policy).Where(p => !string.IsNullOrEmpty(p)).SelectMany(p => p!.Split(',')).Select(p => p.Trim()).ToArray(); diff --git a/Common/OpenApi/OpenShockXmlComments.cs b/Common/OpenApi/OpenShockXmlComments.cs deleted file mode 100644 index 9f946346d..000000000 --- a/Common/OpenApi/OpenShockXmlComments.cs +++ /dev/null @@ -1,70 +0,0 @@ -using System.Reflection; -using System.Xml.Linq; -using Asp.Versioning.OpenApi.Transformers; - -namespace OpenShock.Common.OpenApi; - -/// -/// with its member lookup exposed, so undeclared <response> codes can be enumerated. -/// -public sealed class DocumentedXmlComments(string path) : XmlComments(path) -{ - public XElement? FindMember(MemberInfo member) => GetMember(member); - - /// - /// The library writes nested types as Outer+Inner, but XML documentation ids use Outer.Inner, so a method with a nested - /// type parameter is never found. Falls back to matching the method by declaring type and name (only when that is unambiguous). - /// - protected override XElement? GetMember(MemberInfo member) - { - var found = base.GetMember(member); - if (found is not null || member is not MethodInfo { DeclaringType.FullName: { } typeName } method) return found; - - var prefix = $"M:{typeName.Replace('+', '.')}.{method.Name}"; - var matches = Xml.Descendants("member") - .Where(m => m.Attribute("name")?.Value is { } name && name.StartsWith(prefix, StringComparison.Ordinal) && (name.Length == prefix.Length || name[prefix.Length] == '(')) - .Take(2) - .ToArray(); - - return matches.Length == 1 ? matches[0] : null; - } -} - -/// -/// The library renders a self-closing <see cref="..."/> as nothing, leaving gaps like "An as exposed to admins". -/// Fills those with the referenced member's name, e.g. T:Ns.EmailOutboxMessage becomes EmailOutboxMessage. -/// -public static class XmlCrefText -{ - /// - /// Writes a single XML documentation file merging , with its crefs filled in, and returns its path. - /// The caller deletes it. - /// - public static string CreateFilledCopy(params string[] paths) - { - var xml = XDocument.Load(paths[0]); - - // The consumers read one file, but types live in several assemblies (e.g. the host and Common) - var members = xml.Root!.Element("members")!; - foreach (var path in paths.Skip(1)) - { - members.Add(XDocument.Load(path).Root?.Element("members")?.Elements() ?? []); - } - - foreach (var see in xml.Descendants("see")) - { - if (!see.IsEmpty || see.Attribute("cref")?.Value is not { Length: > 2 } cref) continue; - - // Drop the "T:"/"M:"/... prefix and any parameter list, then keep the last segment - var name = cref[2..]; - var parameters = name.IndexOf('('); - if (parameters >= 0) name = name[..parameters]; - - see.Value = name[(name.LastIndexOf('.') + 1)..]; - } - - var copy = Path.GetTempFileName(); - xml.Save(copy); - return copy; - } -} diff --git a/Common/OpenApi/SupersededVersionApiDescriptionProvider.cs b/Common/OpenApi/SupersededVersionApiDescriptionProvider.cs new file mode 100644 index 000000000..eee2dd508 --- /dev/null +++ b/Common/OpenApi/SupersededVersionApiDescriptionProvider.cs @@ -0,0 +1,48 @@ +using Microsoft.AspNetCore.Mvc.ApiExplorer; + +namespace OpenShock.Common.OpenApi; + +/// +/// Leaves an endpoint out of the OpenAPI document when a newer version of it exists: POST /1/account/login is hidden when +/// POST /2/account/login exists. The old version keeps working, it is just no longer documented. +/// +/// Routes carry their version as a plain leading path segment, e.g. /2/shockers/control. +public sealed class SupersededVersionApiDescriptionProvider : IApiDescriptionProvider +{ + // Runs after the providers that fill in the descriptions (their OnProvidersExecuting has completed by now) + public int Order => 0; + + public void OnProvidersExecuting(ApiDescriptionProviderContext context) + { + } + + public void OnProvidersExecuted(ApiDescriptionProviderContext context) + { + var latest = new Dictionary<(string?, string), int>(); + foreach (var description in context.Results) + { + if (!TryGetVersion(description, out var key, out var version)) continue; + if (!latest.TryGetValue(key, out var current) || version > current) latest[key] = version; + } + + for (var i = context.Results.Count - 1; i >= 0; i--) + { + if (TryGetVersion(context.Results[i], out var key, out var version) && version < latest[key]) context.Results.RemoveAt(i); + } + } + + private static bool TryGetVersion(ApiDescription description, out (string? HttpMethod, string Path) key, out int version) + { + var path = description.RelativePath ?? string.Empty; + var slash = path.IndexOf('/'); + + if (int.TryParse(slash < 0 ? path : path[..slash], out version)) + { + key = (description.HttpMethod?.ToUpperInvariant(), slash < 0 ? string.Empty : path[(slash + 1)..].ToLowerInvariant()); + return true; + } + + key = default; + return false; + } +} diff --git a/Common/OpenShockMiddlewareHelper.cs b/Common/OpenShockMiddlewareHelper.cs index f33b3962e..2eaefb271 100644 --- a/Common/OpenShockMiddlewareHelper.cs +++ b/Common/OpenShockMiddlewareHelper.cs @@ -131,13 +131,12 @@ exception is null return IsAllowed(context.Connection.RemoteIpAddress, internalAllowedIpNetworks); }); - app.MapOpenApi().WithDocumentPerVersion(); + app.MapOpenApi(OpenShockServiceHelper.OpenApiDocumentPath); app.MapScalarApiReference("/scalar/viewer", options => options - .WithOpenApiRoutePattern("/openapi/{documentName}.json") - .AddDocument("1", "Version 1") - .AddDocument("2", "Version 2") + .WithOpenApiRoutePattern(OpenShockServiceHelper.OpenApiDocumentPath) + .AddDocument(OpenShockServiceHelper.OpenApiDocumentName, "OpenShock API") ); // Reports whether every dependency this host needs to serve is reachable. The LCG gates its diff --git a/Common/OpenShockServiceHelper.cs b/Common/OpenShockServiceHelper.cs index 654ef5475..c488a8c4d 100644 --- a/Common/OpenShockServiceHelper.cs +++ b/Common/OpenShockServiceHelper.cs @@ -3,16 +3,17 @@ using System.Reflection; using System.Security.Claims; using System.Threading.RateLimiting; -using Asp.Versioning; -using Asp.Versioning.OpenApi.Transformers; using Microsoft.AspNetCore.Authentication; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.DataProtection; using Microsoft.AspNetCore.Mvc; +using Microsoft.AspNetCore.Mvc.ApiExplorer; +using Microsoft.AspNetCore.OpenApi; using Microsoft.EntityFrameworkCore; using Microsoft.Extensions.Caching.Hybrid; using Microsoft.Extensions.DependencyInjection.Extensions; using Microsoft.OpenApi; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication; using OpenShock.Common.Authentication.AuthenticationHandlers; using OpenShock.Common.Constants; @@ -44,6 +45,17 @@ namespace OpenShock.Common; public static class OpenShockServiceHelper { + /// + /// Name of the single OpenAPI document. It must be the framework's default ("v1"): has no + /// {documentName} segment, so MapOpenApi serves the default document there. It never appears in a URL. + /// + public const string OpenApiDocumentName = "v1"; + + /// + /// Path the OpenAPI document is served at. + /// + public const string OpenApiDocumentPath = "/openapi.json"; + /// /// Cap on a single dependency probe. Generous enough not to trip on a slow-but-alive dependency, /// short enough that the LCG's 15s keep alive tick is never blocked by a hung one. @@ -130,6 +142,71 @@ private static AuthenticationBuilder AddOpenShockAuthentication(this IServiceCol return builder; } + /// + /// Configures the OpenAPI document. Each host registers it itself with + /// services.AddOpenApi(OpenApiDocumentName, ConfigureOpenApi): the XML documentation comments are applied by a source generator + /// that only sees the documentation of the project making that call and of the projects it references, so the call belongs in the host. + /// + public static void ConfigureOpenApi(OpenApiOptions options) + { + options.AddDocumentTransformer((document, context, _) => + { + document.Info.Title = "OpenShock.API"; + document.Info.Version = "1.0"; + document.Info.Description = Assembly.GetEntryAssembly()?.GetCustomAttribute()?.Description; + + var isDevelopment = context.ApplicationServices.GetRequiredService().IsDevelopment(); + var servers = new List + { + new() { Url = "https://api.openshock.app" }, + new() { Url = "https://api.openshock.dev" } + }; + if (isDevelopment) + { + servers.Add(new OpenApiServer { Url = "https://localhost" }); + } + document.Servers = servers; + + document.Components ??= new OpenApiComponents(); + document.Components.SecuritySchemes = new Dictionary + { + [OpenShockAuthSchemes.UserSessionCookie] = new OpenApiSecurityScheme + { + Name = AuthConstants.UserSessionCookieName, + Description = "Enter user session cookie", + In = ParameterLocation.Cookie, + Type = SecuritySchemeType.ApiKey, + Scheme = OpenShockAuthSchemes.UserSessionCookie + }, + [OpenShockAuthSchemes.ApiToken] = new OpenApiSecurityScheme + { + Name = AuthConstants.ApiTokenHeaderName, + Description = "Enter API Token", + In = ParameterLocation.Header, + Type = SecuritySchemeType.ApiKey, + Scheme = OpenShockAuthSchemes.ApiToken + }, + [OpenShockAuthSchemes.HubToken] = new OpenApiSecurityScheme + { + Name = AuthConstants.HubTokenHeaderName, + Description = "Enter hub token", + In = ParameterLocation.Header, + Type = SecuritySchemeType.ApiKey, + Scheme = OpenShockAuthSchemes.HubToken + } + }; + + return Task.CompletedTask; + }); + + options.OpenApiVersion = OpenApiSpecVersion.OpenApi3_2; + options.CreateSchemaReferenceId = OpenShockSchemaIds.Create; + + options.AddOperationTransformer(); + options.AddSchemaTransformer(); + options.AddDocumentTransformer(); + } + /// /// Register all OpenShock services for PRODUCTION use /// @@ -180,120 +257,11 @@ public static IServiceCollection AddOpenShockServices(this IServiceCollection se services.AddSingleton(); services.ConfigureHttpJsonOptions(opt => JsonOptions.ConfigureDefault(opt.SerializerOptions)); - services.AddControllers().AddJsonOptions(opt => JsonOptions.ConfigureDefault(opt.JsonSerializerOptions)); + services.AddControllers(options => options.Conventions.Add(new ApiVersionRouteConvention())).AddJsonOptions(opt => JsonOptions.ConfigureDefault(opt.JsonSerializerOptions)); - var apiVersioningBuilder = services.AddApiVersioning(options => - { - options.DefaultApiVersion = new ApiVersion(1, 0); - options.AssumeDefaultVersionWhenUnspecified = true; - // All routes are versioned via the /{version:apiVersion}/ segment - options.ApiVersionReader = new UrlSegmentApiVersionReader(); - }).AddMvc(); - - apiVersioningBuilder.AddApiExplorer(setup => - { - setup.GroupNameFormat = "VVV"; - setup.SubstituteApiVersionInUrl = true; - setup.DefaultApiVersion = new ApiVersion(1, 0); - setup.AssumeDefaultVersionWhenUnspecified = true; - }); - - apiVersioningBuilder.AddOpenApi(options => - { - var version = options.Description.ApiVersion.ToString(); - var isDeprecated = options.Description.IsDeprecated; - - options.Document.AddDocumentTransformer((document, context, _) => - { - document.Info.Title = "OpenShock.API"; - document.Info.Version = version; - if (isDeprecated) - { - document.Info.Description = (document.Info.Description ?? "") + " This API version has been deprecated."; - } - - var isDevelopment = context.ApplicationServices.GetRequiredService().IsDevelopment(); - var servers = new List - { - new() { Url = "https://api.openshock.app" }, - new() { Url = "https://api.openshock.dev" } - }; - if (isDevelopment) - { - servers.Add(new OpenApiServer { Url = "https://localhost" }); - } - document.Servers = servers; - - document.Components ??= new OpenApiComponents(); - document.Components.SecuritySchemes = new Dictionary - { - [OpenShockAuthSchemes.UserSessionCookie] = new OpenApiSecurityScheme - { - Name = AuthConstants.UserSessionCookieName, - Description = "Enter user session cookie", - In = ParameterLocation.Cookie, - Type = SecuritySchemeType.ApiKey, - Scheme = OpenShockAuthSchemes.UserSessionCookie - }, - [OpenShockAuthSchemes.ApiToken] = new OpenApiSecurityScheme - { - Name = AuthConstants.ApiTokenHeaderName, - Description = "Enter API Token", - In = ParameterLocation.Header, - Type = SecuritySchemeType.ApiKey, - Scheme = OpenShockAuthSchemes.ApiToken - }, - [OpenShockAuthSchemes.HubToken] = new OpenApiSecurityScheme - { - Name = AuthConstants.HubTokenHeaderName, - Description = "Enter hub token", - In = ParameterLocation.Header, - Type = SecuritySchemeType.ApiKey, - Scheme = OpenShockAuthSchemes.HubToken - } - }; - - return Task.CompletedTask; - }); - - options.Document.OpenApiVersion = OpenApiSpecVersion.OpenApi3_2; - options.Document.CreateSchemaReferenceId = OpenShockSchemaIds.Create; - - options.Document.AddOperationTransformer(); - options.Document.AddSchemaTransformer(); - options.Document.AddDocumentTransformer(); - - // Picks up XML doc comments (, , ...) from whichever host process is running - // (API/Cron/LiveControlGateway) and from Common. - var entryAssemblyName = Assembly.GetEntryAssembly()?.GetName().Name; - var xmlPaths = new[] { entryAssemblyName, typeof(OpenShockServiceHelper).Assembly.GetName().Name } - .OfType() - .Distinct() - .Select(name => Path.Combine(AppContext.BaseDirectory, name + ".xml")) - .Where(File.Exists) - .ToArray(); - if (xmlPaths.Length > 0) - { - var filledPath = XmlCrefText.CreateFilledCopy(xmlPaths); - DocumentedXmlComments comments; - XmlCommentsTransformer xmlCommentsTransformer; - try - { - comments = new DocumentedXmlComments(filledPath); - xmlCommentsTransformer = new XmlCommentsTransformer(filledPath); - } - finally - { - File.Delete(filledPath); - } - - options.Document.AddDocumentTransformer(xmlCommentsTransformer); - options.Document.AddDocumentTransformer(new ControllerTagDescriptionTransformer(comments)); - options.Document.AddOperationTransformer(new DocumentedResponsesTransformer(comments)); - options.Document.AddOperationTransformer(xmlCommentsTransformer); - options.Document.AddSchemaTransformer(xmlCommentsTransformer); - } - }); + // Routes carry their version as a plain leading segment (/1/..., /2/...); there is a single document in which a newer + // version of an endpoint replaces the older one. + services.TryAddEnumerable(ServiceDescriptor.Transient()); // generic ASP.NET stuff services.AddMemoryCache(); diff --git a/Common/Utils/Pagination/PagedResult.cs b/Common/Utils/Pagination/PagedResult.cs index 98d8be24b..486d91b56 100644 --- a/Common/Utils/Pagination/PagedResult.cs +++ b/Common/Utils/Pagination/PagedResult.cs @@ -27,7 +27,7 @@ public sealed class PagedResult public required int TotalCount { get; init; } /// - /// Total number of pages. Always at least 1, even when is zero. + /// Total number of pages. Always at least 1, even when TotalCount is zero. /// public uint TotalPages => TotalCount <= 0 ? 1u diff --git a/Cron/Cron.csproj b/Cron/Cron.csproj index 04c332949..86cbee224 100644 --- a/Cron/Cron.csproj +++ b/Cron/Cron.csproj @@ -6,6 +6,8 @@ + + diff --git a/Cron/Program.cs b/Cron/Program.cs index c5d0ea13f..62671fa7e 100644 --- a/Cron/Program.cs +++ b/Cron/Program.cs @@ -17,6 +17,8 @@ builder.Services.AddOpenShockMemDB(redisOptions); builder.Services.AddOpenShockDB(databaseOptions); builder.Services.AddOpenShockServices(); +// XML documentation comments are applied by a source generator that intercepts this call, so it has to be made here in the host +builder.Services.AddOpenApi(OpenShockServiceHelper.OpenApiDocumentName, OpenShockServiceHelper.ConfigureOpenApi); // Hangfire workers fetch enqueued jobs by polling the queue table. The default interval (15s) is // left as-is in production - email delivery within that window is fine and it adds no DB load. Only diff --git a/Directory.Build.props b/Directory.Build.props index ae7020192..a2982166b 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -47,11 +47,9 @@ true - + $(WarningsNotAsErrors);NU1608 diff --git a/Directory.Packages.props b/Directory.Packages.props index 4834aafe9..65b27377a 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -6,8 +6,6 @@ true - - diff --git a/LiveControlGateway/Controllers/HubV1Controller.cs b/LiveControlGateway/Controllers/HubV1Controller.cs index 052b3bd49..8c22df818 100644 --- a/LiveControlGateway/Controllers/HubV1Controller.cs +++ b/LiveControlGateway/Controllers/HubV1Controller.cs @@ -1,7 +1,7 @@ -using Asp.Versioning; -using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.SignalR; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication; using OpenShock.Common.Constants; using OpenShock.Common.Hubs; @@ -22,8 +22,8 @@ namespace OpenShock.LiveControlGateway.Controllers; /// Communication with the hubs aka ESP-32 microcontrollers /// [ApiController] -[ApiVersion("1")] [Route("/{version:apiVersion}/ws/device")] +[ApiVersion(1)] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.HubToken)] public sealed class HubV1Controller : HubControllerBase { diff --git a/LiveControlGateway/Controllers/HubV2Controller.cs b/LiveControlGateway/Controllers/HubV2Controller.cs index 1c03ae78a..87b7a1091 100644 --- a/LiveControlGateway/Controllers/HubV2Controller.cs +++ b/LiveControlGateway/Controllers/HubV2Controller.cs @@ -1,8 +1,8 @@ using System.Diagnostics; -using Asp.Versioning; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.SignalR; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication; using OpenShock.Common.Constants; using OpenShock.Common.Hubs; @@ -21,8 +21,8 @@ namespace OpenShock.LiveControlGateway.Controllers; /// Communication with the hubs aka ESP-32 microcontrollers /// [ApiController] -[ApiVersion("2")] [Route("/{version:apiVersion}/ws/hub")] +[ApiVersion(2)] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.HubToken)] public sealed class HubV2Controller : HubControllerBase { diff --git a/LiveControlGateway/Controllers/InstanceDetailsController.cs b/LiveControlGateway/Controllers/InstanceDetailsController.cs index 70a0a5bd2..45b1ae759 100644 --- a/LiveControlGateway/Controllers/InstanceDetailsController.cs +++ b/LiveControlGateway/Controllers/InstanceDetailsController.cs @@ -1,8 +1,8 @@ using System.Net.Mime; using System.Reflection; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using OpenShock.Common; +using OpenShock.Common.ApiVersioning; using OpenShock.Internal.Common.Utils; using OpenShock.LiveControlGateway.Options; @@ -13,7 +13,6 @@ namespace OpenShock.LiveControlGateway.Controllers; /// [ApiController] [Route("/{version:apiVersion}")] -[ApiVersion("1")] public sealed class InstanceDetailsController : OpenShockControllerBase { private static readonly AssemblyName AssemblyName = typeof(InstanceDetailsController).Assembly.GetName(); @@ -25,8 +24,8 @@ public sealed class InstanceDetailsController : OpenShockControllerBase /// /// Instance details was successfully retrieved. [HttpGet] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] - [MapToApiVersion("1")] public InstanceDetailsResponse GetNodeInfo([FromServices] LcgOptions options) { return new InstanceDetailsResponse diff --git a/LiveControlGateway/Controllers/LiveControlController.cs b/LiveControlGateway/Controllers/LiveControlController.cs index 93e21a286..5d3370d87 100644 --- a/LiveControlGateway/Controllers/LiveControlController.cs +++ b/LiveControlGateway/Controllers/LiveControlController.cs @@ -5,6 +5,7 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.Mvc.Filters; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; @@ -31,8 +32,9 @@ namespace OpenShock.LiveControlGateway.Controllers; /// [ApiController] [Route("/{version:apiVersion}/ws/live/{hubId:guid}")] -[TokenPermission(PermissionType.Shockers_Use)] +[ApiVersion(1)] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.UserSessionApiTokenCombo)] +[TokenPermission(PermissionType.Shockers_Use)] public sealed class LiveControlController : WebsocketBaseController>, IActionFilter { diff --git a/LiveControlGateway/LiveControlGateway.csproj b/LiveControlGateway/LiveControlGateway.csproj index 3ace9585b..affd6e61c 100644 --- a/LiveControlGateway/LiveControlGateway.csproj +++ b/LiveControlGateway/LiveControlGateway.csproj @@ -4,6 +4,8 @@ + + diff --git a/LiveControlGateway/Program.cs b/LiveControlGateway/Program.cs index 7dfab5c02..7642cf16a 100644 --- a/LiveControlGateway/Program.cs +++ b/LiveControlGateway/Program.cs @@ -36,6 +36,9 @@ .AddOpenShockServices(configureMetrics: metricsBuilder => { metricsBuilder.AddMeter("OpenShock.Gateway", GatewayLoadSampler.ResourceMonitoringMeter); }) .AddOpenShockSignalR(redisOptions); +// XML documentation comments are applied by a source generator that intercepts this call, so it has to be made here in the host +builder.Services.AddOpenApi(OpenShockServiceHelper.OpenApiDocumentName, OpenShockServiceHelper.ConfigureOpenApi); + builder.Services.AddScoped(); builder.Services.AddScoped(); builder.Services.AddScoped();