From b157878f012022d463f586112fdebe6ba7ec27e0 Mon Sep 17 00:00:00 2001 From: HeavenVR Date: Wed, 30 Sep 2026 17:52:53 +0200 Subject: [PATCH 1/8] fix: serialize OpenAPI document generation and load XML docs once Asp.Versioning.OpenApi configures every document through one shared factory that keeps state in a field, so two documents requested at the same time (Scalar loads both) corrupt each other and the broken result is cached for the process. Serialize the /openapi endpoints. Also load and merge the XML documentation once per process instead of per document, log when a documentation file is missing or fails to load, and split OpenShockXmlComments.cs into one file per class. --- .../ControllerTagDescriptionTransformer.cs | 5 +- .../OpenApi/DocumentedResponsesTransformer.cs | 1 + Common/OpenApi/DocumentedXmlComments.cs | 77 +++++++++++++++++++ Common/OpenApi/OpenApiXmlDocumentation.cs | 59 ++++++++++++++ Common/OpenApi/OpenShockXmlComments.cs | 70 ----------------- Common/OpenApi/XmlCrefText.cs | 52 +++++++++++++ Common/OpenShockMiddlewareHelper.cs | 19 +++++ Common/OpenShockServiceHelper.cs | 35 ++------- 8 files changed, 218 insertions(+), 100 deletions(-) create mode 100644 Common/OpenApi/DocumentedXmlComments.cs create mode 100644 Common/OpenApi/OpenApiXmlDocumentation.cs delete mode 100644 Common/OpenApi/OpenShockXmlComments.cs create mode 100644 Common/OpenApi/XmlCrefText.cs diff --git a/Common/OpenApi/ControllerTagDescriptionTransformer.cs b/Common/OpenApi/ControllerTagDescriptionTransformer.cs index e02715058..961216b0b 100644 --- a/Common/OpenApi/ControllerTagDescriptionTransformer.cs +++ b/Common/OpenApi/ControllerTagDescriptionTransformer.cs @@ -1,4 +1,5 @@ -using Microsoft.AspNetCore.Http.Metadata; +using Asp.Versioning.OpenApi.Transformers; +using Microsoft.AspNetCore.Http.Metadata; using Microsoft.AspNetCore.Mvc.Controllers; using Microsoft.AspNetCore.OpenApi; using Microsoft.OpenApi; @@ -9,7 +10,7 @@ namespace OpenShock.Common.OpenApi; /// Restores controller class <summary> text as top-level tag descriptions, /// which Swashbuckle's IncludeXmlComments(..., includeControllerXmlComments: true) used to do. /// -public sealed class ControllerTagDescriptionTransformer(DocumentedXmlComments comments) : IOpenApiDocumentTransformer +public sealed class ControllerTagDescriptionTransformer(XmlComments comments) : IOpenApiDocumentTransformer { public Task TransformAsync(OpenApiDocument document, OpenApiDocumentTransformerContext context, CancellationToken cancellationToken) { diff --git a/Common/OpenApi/DocumentedResponsesTransformer.cs b/Common/OpenApi/DocumentedResponsesTransformer.cs index fdb2cf95a..dd8182e88 100644 --- a/Common/OpenApi/DocumentedResponsesTransformer.cs +++ b/Common/OpenApi/DocumentedResponsesTransformer.cs @@ -24,6 +24,7 @@ public Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransform var description = comments.GetResponseDescription(method, code); if (description.Length == 0) continue; + // The library's XmlCommentsTransformer describes existing responses too, but cannot find methods with a nested-type parameter operation.Responses ??= new OpenApiResponses(); if (operation.Responses.TryGetValue(code, out var existing)) { diff --git a/Common/OpenApi/DocumentedXmlComments.cs b/Common/OpenApi/DocumentedXmlComments.cs new file mode 100644 index 000000000..1db71c4bf --- /dev/null +++ b/Common/OpenApi/DocumentedXmlComments.cs @@ -0,0 +1,77 @@ +using System.Collections.Concurrent; +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) +{ + private readonly ConcurrentDictionary _nestedTypeMembers = new(); + + 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. For those methods only, falls back to matching by declaring type, name and parameter count + /// (when that is unambiguous). + /// + protected override XElement? GetMember(MemberInfo member) + { + var found = base.GetMember(member); + if (found is not null || member is not MethodInfo method) return found; + + return HasNestedTypeParameter(method) ? _nestedTypeMembers.GetOrAdd(method, FindByName) : null; + } + + private XElement? FindByName(MethodInfo method) + { + if (method.DeclaringType?.FullName is not { } typeName) return null; + + var prefix = $"M:{typeName.Replace('+', '.')}.{method.Name}"; + var parameterCount = method.GetParameters().Length; + + var matches = Xml.Descendants("member") + .Where(m => m.Attribute("name")?.Value is { } name && name.StartsWith(prefix, StringComparison.Ordinal) && IsSignature(name, prefix.Length, parameterCount)) + .Take(2) + .ToArray(); + + return matches.Length == 1 ? matches[0] : null; + } + + private static bool HasNestedTypeParameter(MethodInfo method) => method.GetParameters().Any(p => ContainsNestedType(p.ParameterType)); + + private static bool ContainsNestedType(Type type) + { + if (type.IsNested) return true; + if (type.HasElementType) return ContainsNestedType(type.GetElementType()!); + return type.IsGenericType && type.GetGenericArguments().Any(ContainsNestedType); + } + + /// + /// Whether the member id continues after with exactly parameters + /// (or ends there, for a method without any). + /// + private static bool IsSignature(string id, int nameLength, int parameterCount) + { + if (id.Length == nameLength) return parameterCount == 0; + if (id[nameLength] != '(') return false; + + var count = 1; + var depth = 0; + foreach (var c in id.AsSpan(nameLength + 1)) + { + switch (c) + { + case '{' or '[': depth++; break; + case '}' or ']': depth--; break; + case ',' when depth == 0: count++; break; + } + } + + return count == parameterCount; + } +} diff --git a/Common/OpenApi/OpenApiXmlDocumentation.cs b/Common/OpenApi/OpenApiXmlDocumentation.cs new file mode 100644 index 000000000..f56956e45 --- /dev/null +++ b/Common/OpenApi/OpenApiXmlDocumentation.cs @@ -0,0 +1,59 @@ +using System.Reflection; +using Asp.Versioning.OpenApi.Transformers; +using Serilog; + +namespace OpenShock.Common.OpenApi; + +/// +/// The XML documentation of the running host and of Common, loaded once per process and shared by every OpenAPI document. +/// Documentation is optional: when it cannot be loaded the documents are served without descriptions. +/// +internal sealed class OpenApiXmlDocumentation +{ + private static readonly Lazy Shared = new(Load); + + public required DocumentedXmlComments Comments { get; init; } + public required XmlCommentsTransformer Transformer { get; init; } + + public static OpenApiXmlDocumentation? Get() => Shared.Value; + + private static OpenApiXmlDocumentation? Load() + { + try + { + // Documentation of whichever host is running (API/Cron/LiveControlGateway), plus the shared Common assembly + var names = new[] { Assembly.GetEntryAssembly()?.GetName().Name, typeof(OpenApiXmlDocumentation).Assembly.GetName().Name } + .OfType() + .Distinct(); + + var paths = new List(); + foreach (var path in names.Select(name => Path.Combine(AppContext.BaseDirectory, name + ".xml"))) + { + if (File.Exists(path)) paths.Add(path); + else Log.Warning("OpenAPI XML documentation file {Path} was not found, its descriptions are left out", path); + } + + if (paths.Count == 0) return null; + + // The library only reads documentation from a file, so the merged copy exists just while it is loaded + var filledPath = XmlCrefText.CreateFilledCopy(paths); + try + { + return new OpenApiXmlDocumentation + { + Comments = new DocumentedXmlComments(filledPath), + Transformer = new XmlCommentsTransformer(filledPath) + }; + } + finally + { + File.Delete(filledPath); + } + } + catch (Exception e) + { + Log.Warning(e, "Failed to load OpenAPI XML documentation, documents are served without descriptions"); + return null; + } + } +} 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/XmlCrefText.cs b/Common/OpenApi/XmlCrefText.cs new file mode 100644 index 000000000..456800968 --- /dev/null +++ b/Common/OpenApi/XmlCrefText.cs @@ -0,0 +1,52 @@ +using System.Xml.Linq; + +namespace OpenShock.Common.OpenApi; + +/// +/// 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. +/// +internal 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(IReadOnlyList paths) + { + // Whitespace is significant: it is the space between adjacent tags and the margin the library strips + var xml = XDocument.Load(paths[0], LoadOptions.PreserveWhitespace); + + // 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, LoadOptions.PreserveWhitespace).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(); + try + { + xml.Save(copy, SaveOptions.DisableFormatting); + } + catch + { + File.Delete(copy); + throw; + } + + return copy; + } +} diff --git a/Common/OpenShockMiddlewareHelper.cs b/Common/OpenShockMiddlewareHelper.cs index e0bc4ae5e..bc59762ee 100644 --- a/Common/OpenShockMiddlewareHelper.cs +++ b/Common/OpenShockMiddlewareHelper.cs @@ -21,6 +21,8 @@ namespace OpenShock.Common; public static class OpenShockMiddlewareHelper { + private static readonly SemaphoreSlim OpenApiDocumentGate = new(1, 1); + private static readonly ForwardedHeadersOptions ForwardedSettings = new() { ForwardedHeaders = ForwardedHeaders.All, @@ -123,6 +125,23 @@ exception is null return IsAllowed(context.Connection.RemoteIpAddress, internalAllowedIpNetworks); }); + // Asp.Versioning.OpenApi builds the options of each document through one shared factory that keeps its state in a field, + // so two documents first requested at the same time (the Scalar viewer loads both) corrupt each other: one request fails + // with a NullReferenceException and the other gets an unconfigured document, and both results are cached for the process. + // Serializing the document endpoints avoids that; they are rarely hit, so the lost concurrency does not matter. + app.UseWhen(context => context.Request.Path.StartsWithSegments("/openapi"), branch => branch.Use(async (context, next) => + { + await OpenApiDocumentGate.WaitAsync(context.RequestAborted); + try + { + await next(context); + } + finally + { + OpenApiDocumentGate.Release(); + } + })); + app.MapOpenApi("/openapi/{documentName}.json").WithDocumentPerVersion(); app.MapScalarApiReference("/scalar/viewer", options => diff --git a/Common/OpenShockServiceHelper.cs b/Common/OpenShockServiceHelper.cs index 5a657b5e9..6c592d5bc 100644 --- a/Common/OpenShockServiceHelper.cs +++ b/Common/OpenShockServiceHelper.cs @@ -266,35 +266,14 @@ public static IServiceCollection AddOpenShockServices(this IServiceCollection se options.Document.AddDocumentTransformer(); options.Document.AddDocumentTransformer(); - // Picks up XML doc comments (, , ...) from whichever host process is running - // (API/Cron/LiveControlGateway) and from Common, mirroring what Swashbuckle's IncludeXmlComments used to do. - 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) + // Picks up XML doc comments (, , ...), mirroring what Swashbuckle's IncludeXmlComments used to do. + if (OpenApiXmlDocumentation.Get() is { } documentation) { - 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); + options.Document.AddDocumentTransformer(documentation.Transformer); + options.Document.AddDocumentTransformer(new ControllerTagDescriptionTransformer(documentation.Comments)); + options.Document.AddOperationTransformer(new DocumentedResponsesTransformer(documentation.Comments)); + options.Document.AddOperationTransformer(documentation.Transformer); + options.Document.AddSchemaTransformer(documentation.Transformer); } }); From 876c18d060160a024fcdcb2c2a7dae038f8f1c12 Mon Sep 17 00:00:00 2001 From: HeavenVR Date: Sun, 15 Nov 2026 11:48:39 +0100 Subject: [PATCH 2/8] refactor: replace Asp.Versioning with method-level versioning and a single OpenAPI document - Add a homegrown [ApiVersion(n)] for action methods. Routes mark the version with the {version:apiVersion} placeholder, and an application model convention fills it in. Startup fails if a versioned action's route has no placeholder, or a placeholder has no version. - Serve one OpenAPI document (/openapi/openshock.json) instead of one per version. A versioned operation is hidden when a newer version exists at the same path and method. - Use the built-in Microsoft.AspNetCore.OpenApi XML comment source generator instead of our own XML parsing. Each host calls AddOpenApi with the shared ConfigureOpenApi, since the generator only runs where that call is made. - LCG websocket controllers override the shared Get so the version sits on a method. - Remove the Asp.Versioning packages and the empty / doc tags. Endpoint paths are unchanged, except /2/account/username/check and /2/tokens/report, which were only exposed under v2 as a side effect of class-level versioning and are now v1 only. --- API/API.csproj | 2 + API/Controller/Account/Activate.cs | 5 +- .../Account/Authenticated/ChangeEmail.cs | 2 + .../Account/Authenticated/ChangePassword.cs | 4 +- .../Account/Authenticated/ChangeUsername.cs | 4 +- .../Account/Authenticated/Deactivate.cs | 3 + .../Account/Authenticated/GetAuditLog.cs | 2 + .../Authenticated/OAuthConnectionRemove.cs | 3 + .../Authenticated/OAuthConnectionsList.cs | 3 + .../Account/Authenticated/_ApiController.cs | 4 +- API/Controller/Account/CheckUsername.cs | 5 +- API/Controller/Account/Login.cs | 4 +- API/Controller/Account/LoginV2.cs | 4 +- API/Controller/Account/Logout.cs | 4 +- .../Account/PasswordResetCheckValid.cs | 6 +- .../Account/PasswordResetComplete.cs | 6 +- .../Account/PasswordResetInitiate.cs | 4 +- .../Account/PasswordResetInitiateV2.cs | 6 +- API/Controller/Account/Signup.cs | 4 +- API/Controller/Account/SignupV2.cs | 4 +- API/Controller/Account/VerifyEmail.cs | 6 +- API/Controller/Account/_ApiController.cs | 46 +++-- API/Controller/Admin/Configuration.cs | 7 +- API/Controller/Admin/DeactivateUser.cs | 3 + API/Controller/Admin/DeleteUser.cs | 3 + API/Controller/Admin/EmailOutboxBulk.cs | 4 + API/Controller/Admin/EmailOutboxCancel.cs | 2 + API/Controller/Admin/EmailOutboxDelete.cs | 2 + API/Controller/Admin/EmailOutboxList.cs | 2 + API/Controller/Admin/EmailOutboxRequeue.cs | 2 + API/Controller/Admin/EmailOutboxStats.cs | 2 + API/Controller/Admin/EmailOutboxTestSend.cs | 2 + .../Admin/EmailProviderBlacklistAdd.cs | 2 + .../Admin/EmailProviderBlacklistList.cs | 2 + .../Admin/EmailProviderBlacklistRemove.cs | 2 + API/Controller/Admin/GetAuditLog.cs | 2 + API/Controller/Admin/GetOnlineDevices.cs | 3 + API/Controller/Admin/GetUsers.cs | 3 + API/Controller/Admin/PatchUser.cs | 3 + API/Controller/Admin/ReactivateUser.cs | 3 + API/Controller/Admin/UserNameBlacklistAdd.cs | 2 + API/Controller/Admin/UserNameBlacklistList.cs | 2 + .../Admin/UserNameBlacklistRemove.cs | 2 + API/Controller/Admin/WebhookAdd.cs | 3 + API/Controller/Admin/WebhookList.cs | 3 + API/Controller/Admin/WebhookRemove.cs | 3 + API/Controller/Device/AssignLCG.cs | 4 +- API/Controller/Device/AssignLCGV2.cs | 4 +- API/Controller/Device/GetSelf.cs | 4 +- API/Controller/Device/Pair.cs | 6 +- API/Controller/Device/_ApiController.cs | 5 +- API/Controller/Devices/DeviceOtaController.cs | 6 +- API/Controller/Devices/DevicesController.cs | 22 +-- API/Controller/Devices/GetShockers.cs | 4 +- API/Controller/Devices/_ApiController.cs | 4 +- API/Controller/OAuth/Authorize.cs | 2 + API/Controller/OAuth/HandOff.cs | 4 +- API/Controller/OAuth/SignupFinalize.cs | 4 +- API/Controller/OAuth/SignupGetData.cs | 4 +- API/Controller/OAuth/_ApiController.cs | 2 - API/Controller/Public/GetStats.cs | 4 +- .../Public/PublicShareController.cs | 4 +- API/Controller/Sessions/DeleteSessions.cs | 3 + API/Controller/Sessions/ListSessions.cs | 3 + API/Controller/Sessions/SessionSelf.cs | 4 +- API/Controller/Sessions/_ApiController.cs | 4 +- API/Controller/Shares/DeleteShareCode.cs | 5 +- API/Controller/Shares/LinkShareCode.cs | 5 +- API/Controller/Shares/Links/AddShocker.cs | 4 +- .../Shares/Links/CreatePublicShare.cs | 4 +- .../Shares/Links/DeletePublicShare.cs | 4 +- API/Controller/Shares/Links/EditShocker.cs | 4 +- API/Controller/Shares/Links/List.cs | 4 +- API/Controller/Shares/Links/PauseShocker.cs | 4 +- API/Controller/Shares/Links/RemoveShocker.cs | 4 +- .../Shares/UserShares/CreateShareInvite.cs | 4 +- API/Controller/Shares/UserShares/GetShares.cs | 4 +- API/Controller/Shares/UserShares/Invites.cs | 13 +- .../Shares/UserShares/PauseShockerShares.cs | 4 +- .../Shares/UserShares/RemoveShockerShares.cs | 4 +- .../Shares/UserShares/UpdateShockerShares.cs | 4 +- .../Shares/UserShares/_ApiController.cs | 4 +- API/Controller/Shares/_ApiController.cs | 4 +- API/Controller/Shockers/EditShocker.cs | 4 +- API/Controller/Shockers/GetShockerById.cs | 4 +- API/Controller/Shockers/GetShockerLogs.cs | 6 +- API/Controller/Shockers/ListSharedShockers.cs | 4 +- API/Controller/Shockers/ListShockers.cs | 4 +- API/Controller/Shockers/PauseShocker.cs | 4 +- API/Controller/Shockers/RegisterShocker.cs | 4 +- API/Controller/Shockers/RemoveShocker.cs | 4 +- API/Controller/Shockers/SendControl.cs | 6 +- API/Controller/Shockers/ShockerShares.cs | 15 +- API/Controller/Shockers/_ApiController.cs | 4 +- API/Controller/Tokens/DeleteToken.cs | 4 +- API/Controller/Tokens/GetTokenSelf.cs | 9 +- API/Controller/Tokens/ReportTokens.cs | 3 + API/Controller/Tokens/Tokens.cs | 20 +- API/Controller/Tokens/_ApiController.cs | 4 +- API/Controller/Users/GetSelf.cs | 4 +- API/Controller/Users/LookupByName.cs | 4 +- API/Controller/Version/_ApiController.cs | 6 +- API/Program.cs | 3 + Common/ApiVersioning/ApiVersionAttribute.cs | 19 ++ .../ApiVersionRouteConvention.cs | 69 +++++++ Common/Common.csproj | 2 - .../ControllerTagDescriptionTransformer.cs | 52 ------ .../OpenApi/DocumentedResponsesTransformer.cs | 41 ---- Common/OpenApi/DocumentedXmlComments.cs | 77 -------- Common/OpenApi/OpenApiXmlDocumentation.cs | 59 ------ ...SupersededVersionApiDescriptionProvider.cs | 48 +++++ Common/OpenApi/XmlCrefText.cs | 52 ------ Common/OpenShockMiddlewareHelper.cs | 25 +-- Common/OpenShockServiceHelper.cs | 175 ++++++++---------- Common/Utils/Pagination/PagedResult.cs | 2 +- Common/Websocket/WebsockBaseController.cs | 2 +- Cron/Cron.csproj | 2 + Cron/Program.cs | 2 + Directory.Build.props | 7 - Directory.Packages.props | 2 - .../Controllers/HubV1Controller.cs | 8 +- .../Controllers/HubV2Controller.cs | 10 +- .../Controllers/InstanceDetailsController.cs | 5 +- .../Controllers/LiveControlController.cs | 8 +- LiveControlGateway/LiveControlGateway.csproj | 5 + LiveControlGateway/Program.cs | 3 + 126 files changed, 549 insertions(+), 613 deletions(-) create mode 100644 Common/ApiVersioning/ApiVersionAttribute.cs create mode 100644 Common/ApiVersioning/ApiVersionRouteConvention.cs delete mode 100644 Common/OpenApi/ControllerTagDescriptionTransformer.cs delete mode 100644 Common/OpenApi/DocumentedResponsesTransformer.cs delete mode 100644 Common/OpenApi/DocumentedXmlComments.cs delete mode 100644 Common/OpenApi/OpenApiXmlDocumentation.cs create mode 100644 Common/OpenApi/SupersededVersionApiDescriptionProvider.cs delete mode 100644 Common/OpenApi/XmlCrefText.cs 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 0f941501c..7c54454d3 100644 --- a/API/Controller/Account/Activate.cs +++ b/API/Controller/Account/Activate.cs @@ -1,6 +1,6 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Problems; @@ -13,11 +13,10 @@ public sealed partial class AccountController /// /// Activate account /// - /// [HttpPost("activate")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] - [MapToApiVersion("1")] + [ApiVersion(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 cbffd17b4..0ff3fbb2b 100644 --- a/API/Controller/Account/Authenticated/ChangeEmail.cs +++ b/API/Controller/Account/Authenticated/ChangeEmail.cs @@ -7,6 +7,7 @@ using OpenShock.Common.Problems; using OpenShock.Common.Utils; using Results = OpenShock.Common.Results; +using OpenShock.Common.ApiVersioning; using OpenShock.Internal.Common.Utils; @@ -30,6 +31,7 @@ public sealed partial class AuthenticatedAccountController [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] // EmailChangeAlreadyInUse [ProducesResponseType(StatusCodes.Status429TooManyRequests, MediaTypeNames.Application.ProblemJson)] // EmailChangeTooMany // notActivated / deactivated / notFound are blocked by UserSessionAuthentication before reaching this controller. + [ApiVersion(1)] public async Task ChangeEmail([FromBody] ChangeEmailRequest body) { if (string.IsNullOrEmpty(CurrentUser.PasswordHash)) diff --git a/API/Controller/Account/Authenticated/ChangePassword.cs b/API/Controller/Account/Authenticated/ChangePassword.cs index ea414d1e9..c295d8b0c 100644 --- a/API/Controller/Account/Authenticated/ChangePassword.cs +++ b/API/Controller/Account/Authenticated/ChangePassword.cs @@ -12,6 +12,8 @@ using OpenShock.Internal.Common.Problems; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Account.Authenticated; public sealed partial class AuthenticatedAccountController @@ -20,7 +22,6 @@ public sealed partial class AuthenticatedAccountController /// Change the password of the current user /// /// - /// /// [HttpPost("password")] [Consumes(MediaTypeNames.Application.Json)] @@ -28,6 +29,7 @@ public sealed partial class AuthenticatedAccountController [ProducesResponseType(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] // PasswordChangeInvalidPassword [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] // PasswordNotSet // notActivated / deactivated / notFound are blocked by UserSessionAuthentication before reaching this controller. + [ApiVersion(1)] public async Task ChangePassword([FromBody] ChangePasswordRequest body) { // OAuth-only accounts that have never set a password must go through the email-confirmed diff --git a/API/Controller/Account/Authenticated/ChangeUsername.cs b/API/Controller/Account/Authenticated/ChangeUsername.cs index 6bc21e585..74401402c 100644 --- a/API/Controller/Account/Authenticated/ChangeUsername.cs +++ b/API/Controller/Account/Authenticated/ChangeUsername.cs @@ -11,6 +11,8 @@ using OpenShock.Internal.Common.Problems; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Account.Authenticated; public sealed partial class AuthenticatedAccountController @@ -19,7 +21,6 @@ public sealed partial class AuthenticatedAccountController /// Change the username of the current user /// /// - /// /// [HttpPost("username")] [Consumes(MediaTypeNames.Application.Json)] @@ -27,6 +28,7 @@ public sealed partial class AuthenticatedAccountController [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] // UsernameTaken [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // UsernameInvalid [ProducesResponseType(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] // UsernameRecentlyChanged + [ApiVersion(1)] public async Task ChangeUsername([FromBody] ChangeUsernameRequest body) { var result = await _accountService.ChangeUsernameAsync(CurrentUser.Id, body.Username, actorId: CurrentUser.Id, diff --git a/API/Controller/Account/Authenticated/Deactivate.cs b/API/Controller/Account/Authenticated/Deactivate.cs index ef0d66c6e..a73356a88 100644 --- a/API/Controller/Account/Authenticated/Deactivate.cs +++ b/API/Controller/Account/Authenticated/Deactivate.cs @@ -9,6 +9,8 @@ using OpenShock.Internal.Common.Problems; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Account.Authenticated; public sealed partial class AuthenticatedAccountController @@ -20,6 +22,7 @@ public sealed partial class AuthenticatedAccountController [HttpDelete] [ProducesResponseType(StatusCodes.Status204NoContent)] [ProducesResponseType(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] // CannotDeactivatePrivledgedAccount + [ApiVersion(1)] public async Task Deactivate() { var deactivationResult = await _accountService.DeactivateAccountAsync(CurrentUser.Id, CurrentUser.Id, deleteLater: true); diff --git a/API/Controller/Account/Authenticated/GetAuditLog.cs b/API/Controller/Account/Authenticated/GetAuditLog.cs index cd88e2600..cbddd2bcc 100644 --- a/API/Controller/Account/Authenticated/GetAuditLog.cs +++ b/API/Controller/Account/Authenticated/GetAuditLog.cs @@ -4,6 +4,7 @@ using OpenShock.Common.OpenShockDb; using OpenShock.Common.Services.Audit; using OpenShock.Common.Utils.Pagination; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Account.Authenticated; @@ -18,6 +19,7 @@ public sealed partial class AuthenticatedAccountController /// A page of audit log entries. [HttpGet("audit-log")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] + [ApiVersion(1)] public async Task> GetAuditLog( [FromQuery] PaginationQuery pagination, [FromServices] IAuditService auditService, diff --git a/API/Controller/Account/Authenticated/OAuthConnectionRemove.cs b/API/Controller/Account/Authenticated/OAuthConnectionRemove.cs index eb9abcf3e..0bfd136a6 100644 --- a/API/Controller/Account/Authenticated/OAuthConnectionRemove.cs +++ b/API/Controller/Account/Authenticated/OAuthConnectionRemove.cs @@ -1,6 +1,8 @@ using Microsoft.AspNetCore.Mvc; using OpenShock.API.Services.OAuthConnection; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Account.Authenticated; public sealed partial class AuthenticatedAccountController @@ -16,6 +18,7 @@ public sealed partial class AuthenticatedAccountController [HttpDelete("connections/{provider}")] [ProducesResponseType(StatusCodes.Status204NoContent)] [ProducesResponseType(StatusCodes.Status404NotFound)] + [ApiVersion(1)] public async Task RemoveOAuthConnection([FromRoute] string provider, [FromServices] IOAuthConnectionService connectionService, CancellationToken cancellationToken) { var deleted = await connectionService.TryRemoveConnectionAsync(CurrentUser.Id, provider, actorId: CurrentUser.Id, cancellationToken); diff --git a/API/Controller/Account/Authenticated/OAuthConnectionsList.cs b/API/Controller/Account/Authenticated/OAuthConnectionsList.cs index bfd204cb0..9c2b082ef 100644 --- a/API/Controller/Account/Authenticated/OAuthConnectionsList.cs +++ b/API/Controller/Account/Authenticated/OAuthConnectionsList.cs @@ -4,6 +4,8 @@ using OpenShock.API.Models.Response; using OpenShock.API.Services.OAuthConnection; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Account.Authenticated; public sealed partial class AuthenticatedAccountController @@ -15,6 +17,7 @@ public sealed partial class AuthenticatedAccountController /// Returns the list of connections. [HttpGet("connections")] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] + [ApiVersion(1)] public IActionResult ListOAuthConnections([FromServices] IOAuthConnectionService connectionService, CancellationToken cancellationToken) { return Ok(connectionService diff --git a/API/Controller/Account/Authenticated/_ApiController.cs b/API/Controller/Account/Authenticated/_ApiController.cs index 3e7e3a75a..c66f08974 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 b533c87e5..a6ce08193 100644 --- a/API/Controller/Account/CheckUsername.cs +++ b/API/Controller/Account/CheckUsername.cs @@ -1,4 +1,5 @@ -using System.Diagnostics; +using OpenShock.Common.ApiVersioning; +using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Net.Mime; using Microsoft.AspNetCore.Mvc; @@ -16,7 +17,7 @@ public sealed partial class AccountController /// /// /// - /// + [ApiVersion(1)] [HttpPost("username/check")] // High-volume endpoint, we don't want to rate limit this [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 9a8291d5e..bf15dc325 100644 --- a/API/Controller/Account/Login.cs +++ b/API/Controller/Account/Login.cs @@ -1,4 +1,4 @@ -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using OpenShock.Common.Errors; @@ -14,6 +14,6 @@ public sealed partial class AccountController [HttpPost("login")] [Obsolete("Retired. Use POST /2/account/login instead.")] [ApiExplorerSettings(IgnoreApi = true)] - [MapToApiVersion("1")] + [ApiVersion(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 b9139e4d3..11d11375d 100644 --- a/API/Controller/Account/LoginV2.cs +++ b/API/Controller/Account/LoginV2.cs @@ -2,7 +2,7 @@ using OpenShock.API.Models.Requests; using System.Diagnostics; using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.Services.Account; using OpenShock.Common.Errors; @@ -29,7 +29,7 @@ public sealed partial class AccountController [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status401Unauthorized, MediaTypeNames.Application.ProblemJson)] // InvalidCredentials [ProducesResponseType(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] // InvalidDomain - [MapToApiVersion("2")] + [ApiVersion(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 7a530793e..c4abad943 100644 --- a/API/Controller/Account/Logout.cs +++ b/API/Controller/Account/Logout.cs @@ -1,4 +1,4 @@ -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using OpenShock.Common.Extensions; using OpenShock.Common.Services.Session; @@ -9,7 +9,7 @@ public sealed partial class AccountController { [HttpPost("logout")] [ProducesResponseType(StatusCodes.Status200OK)] - [MapToApiVersion("1")] + [ApiVersion(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 deee79e89..f33fc5369 100644 --- a/API/Controller/Account/PasswordResetCheckValid.cs +++ b/API/Controller/Account/PasswordResetCheckValid.cs @@ -2,7 +2,7 @@ using System.Diagnostics; using Microsoft.AspNetCore.Mvc; using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.Services.Account; using OpenShock.Common.Errors; @@ -24,7 +24,7 @@ public sealed partial class AccountController [Obsolete("Retired. Use GET /1/account/password-reset/{passwordResetId}/{secret} instead.")] [HttpHead("recover/{passwordResetId}/{secret}")] [ApiExplorerSettings(IgnoreApi = true)] - [MapToApiVersion("1")] + [ApiVersion(1)] public IActionResult PasswordResetCheckValidLegacy([FromRoute] Guid passwordResetId, [FromRoute] string secret) => Problem(GoneError.EndpointRetired("GET /1/account/password-reset/{passwordResetId}/{secret}")); @@ -40,7 +40,7 @@ public IActionResult PasswordResetCheckValidLegacy([FromRoute] Guid passwordRese [EnableRateLimiting("auth")] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // PasswordResetNotFound - [MapToApiVersion("1")] + [ApiVersion(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 b524b1e2f..866328f36 100644 --- a/API/Controller/Account/PasswordResetComplete.cs +++ b/API/Controller/Account/PasswordResetComplete.cs @@ -2,7 +2,7 @@ using System.Diagnostics; using Microsoft.AspNetCore.Mvc; using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.Services.Account; using OpenShock.Common.Errors; @@ -24,7 +24,7 @@ public sealed partial class AccountController [Obsolete("Retired. Use POST /1/account/password-reset/{passwordResetId}/{secret}/complete instead.")] [HttpPost("recover/{passwordResetId}/{secret}")] [ApiExplorerSettings(IgnoreApi = true)] - [MapToApiVersion("1")] + [ApiVersion(1)] public IActionResult PasswordResetCompleteLegacy([FromRoute] Guid passwordResetId, [FromRoute] string secret) => Problem(GoneError.EndpointRetired("POST /1/account/password-reset/{passwordResetId}/{secret}/complete")); @@ -41,7 +41,7 @@ public IActionResult PasswordResetCompleteLegacy([FromRoute] Guid passwordResetI [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // PasswordResetNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task PasswordResetComplete([FromRoute] Guid passwordResetId, [FromRoute] string secret, [FromBody] PasswordResetProcessData body) { diff --git a/API/Controller/Account/PasswordResetInitiate.cs b/API/Controller/Account/PasswordResetInitiate.cs index 53a1abe17..5cbdd2e6f 100644 --- a/API/Controller/Account/PasswordResetInitiate.cs +++ b/API/Controller/Account/PasswordResetInitiate.cs @@ -1,4 +1,4 @@ -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using OpenShock.Common.Errors; @@ -12,6 +12,6 @@ public sealed partial class AccountController [HttpPost("reset")] [Obsolete("Retired. Use POST /2/account/password-reset instead.")] [ApiExplorerSettings(IgnoreApi = true)] - [MapToApiVersion("1")] + [ApiVersion(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 1bc1cc31e..00d08e34d 100644 --- a/API/Controller/Account/PasswordResetInitiateV2.cs +++ b/API/Controller/Account/PasswordResetInitiateV2.cs @@ -1,6 +1,6 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.Models.Requests; using OpenShock.API.Services.Turnstile; @@ -19,7 +19,7 @@ public sealed partial class AccountController [Obsolete("Retired. Use POST /2/account/password-reset instead.")] [HttpPost("reset-password")] [ApiExplorerSettings(IgnoreApi = true)] - [MapToApiVersion("2")] + [ApiVersion(2)] public IActionResult PasswordResetInitiateV2Legacy() => Problem(GoneError.EndpointRetired("POST /2/account/password-reset")); /// @@ -31,7 +31,7 @@ public sealed partial class AccountController [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] - [MapToApiVersion("2")] + [ApiVersion(2)] public async Task PasswordResetInitiateV2([FromBody] PasswordResetRequestV2 body, [FromServices] ICloudflareTurnstileService turnstileService, CancellationToken cancellationToken) { var turnstileError = await VerifyTurnstileAsync(turnstileService, body.TurnstileResponse, cancellationToken); diff --git a/API/Controller/Account/Signup.cs b/API/Controller/Account/Signup.cs index 5b8ffbb9d..02213fd38 100644 --- a/API/Controller/Account/Signup.cs +++ b/API/Controller/Account/Signup.cs @@ -1,4 +1,4 @@ -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using OpenShock.Common.Errors; @@ -14,6 +14,6 @@ public sealed partial class AccountController [HttpPost("signup")] [Obsolete("Retired. Use POST /2/account/signup instead.")] [ApiExplorerSettings(IgnoreApi = true)] - [MapToApiVersion("1")] + [ApiVersion(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 2b02a3496..0122ace21 100644 --- a/API/Controller/Account/SignupV2.cs +++ b/API/Controller/Account/SignupV2.cs @@ -3,7 +3,7 @@ using OpenShock.API.Services.Account; using System.Diagnostics; using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.Services.Turnstile; using OpenShock.Common.Errors; @@ -33,7 +33,7 @@ public sealed partial class AccountController [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] // EmailOrUsernameAlreadyExists [ProducesResponseType(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] // RegistrationDisabled or InvalidTurnstileResponse - [MapToApiVersion("2")] + [ApiVersion(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 77a579f0a..6ea882e61 100644 --- a/API/Controller/Account/VerifyEmail.cs +++ b/API/Controller/Account/VerifyEmail.cs @@ -2,7 +2,7 @@ using System.Diagnostics; using System.Net.Mime; using Microsoft.AspNetCore.Mvc; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using OpenShock.API.Services.Account; using OpenShock.Common.Errors; using OpenShock.Common.Problems; @@ -24,7 +24,7 @@ public sealed partial class AccountController [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] - [MapToApiVersion("1")] + [ApiVersion(1)] public Task EmailVerify([FromQuery(Name = "token")] string token, CancellationToken cancellationToken) => VerifyPendingEmailChange(token, cancellationToken); @@ -39,7 +39,7 @@ public Task EmailVerify([FromQuery(Name = "token")] string token, [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] - [MapToApiVersion("1")] + [ApiVersion(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 a68582c70..01d916234 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.Common; -using OpenShock.API.Services.Account; - -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.Common; +using OpenShock.API.Services.Account; + +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; + } } \ No newline at end of file diff --git a/API/Controller/Admin/Configuration.cs b/API/Controller/Admin/Configuration.cs index 45e8e639e..3baa0e517 100644 --- a/API/Controller/Admin/Configuration.cs +++ b/API/Controller/Admin/Configuration.cs @@ -9,6 +9,8 @@ using OpenShock.Internal.Common.Problems; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController @@ -16,10 +18,10 @@ public sealed partial class AdminController /// /// Gets all configuration items /// - /// /// Unauthorized [HttpGet("config")] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] // Ok + [ApiVersion(1)] public IAsyncEnumerable ConfigurationList([FromServices] IConfigurationService configurationService) { PedanticallyEnsureAdmin(); @@ -50,6 +52,7 @@ public IAsyncEnumerable ConfigurationList([FromServices] I [ProducesResponseType(StatusCodes.Status200OK)] // Ok [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] // AlreadyExists [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // InvalidNameFormat, InvalidValueFormat + [ApiVersion(1)] public async Task ConfigurationAdd([FromBody] ConfigurationAddItemRequest body, [FromServices] IConfigurationService configurationService, CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); @@ -83,6 +86,7 @@ public async Task ConfigurationAdd([FromBody] ConfigurationAddIte [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] // AlreadyExists [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // Not found [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // InvalidNameFormat, InvalidValueFormat + [ApiVersion(1)] public async Task ConfigurationUpdate([FromBody] ConfigurationUpdateItemRequest body, [FromServices] IConfigurationService configurationService, CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); @@ -113,6 +117,7 @@ public async Task ConfigurationUpdate([FromBody] ConfigurationUpd [ProducesResponseType(StatusCodes.Status200OK)] // Deleted [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // Not found [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // InvalidNameFormat + [ApiVersion(1)] public async Task ConfigurationDelete([FromRoute] string name, [FromServices] IConfigurationService configurationService, CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/DeactivateUser.cs b/API/Controller/Admin/DeactivateUser.cs index 4eecea7d6..a37cdbf4c 100644 --- a/API/Controller/Admin/DeactivateUser.cs +++ b/API/Controller/Admin/DeactivateUser.cs @@ -7,6 +7,8 @@ using AccountSvc = OpenShock.API.Services.Account; using Results = OpenShock.Common.Results; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController @@ -18,6 +20,7 @@ public sealed partial class AdminController /// Unauthorized [HttpPut("users/{userId}/deactivate")] [ProducesResponseType(StatusCodes.Status200OK)] + [ApiVersion(1)] public async Task DeactivateUser( [FromRoute] Guid userId, [FromQuery(Name = "deleteLater")] bool deleteLater, diff --git a/API/Controller/Admin/DeleteUser.cs b/API/Controller/Admin/DeleteUser.cs index 5197d4110..0dfad7c52 100644 --- a/API/Controller/Admin/DeleteUser.cs +++ b/API/Controller/Admin/DeleteUser.cs @@ -7,6 +7,8 @@ using AccountSvc = OpenShock.API.Services.Account; using Results = OpenShock.Common.Results; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController @@ -18,6 +20,7 @@ public sealed partial class AdminController /// Unauthorized [HttpDelete("users/{userId}")] [ProducesResponseType(StatusCodes.Status200OK)] + [ApiVersion(1)] public async Task DeleteUser( [FromRoute] Guid userId, [FromQuery][MaxLength(ApiHardLimits.AuditReasonMaxLength)] string? reason, diff --git a/API/Controller/Admin/EmailOutboxBulk.cs b/API/Controller/Admin/EmailOutboxBulk.cs index 6c10389f1..ae1be2b9d 100644 --- a/API/Controller/Admin/EmailOutboxBulk.cs +++ b/API/Controller/Admin/EmailOutboxBulk.cs @@ -4,6 +4,7 @@ using OpenShock.API.Controller.Admin.DTOs; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Services.RedisPubSub; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; @@ -19,6 +20,7 @@ public sealed partial class AdminController [HttpPost("email/outbox/bulk/requeue")] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] + [ApiVersion(1)] public async Task BulkRequeueEmailOutbox([FromBody] EmailOutboxBulkRequest body, [FromServices] IRedisPubService redisPubService, CancellationToken ct) { PedanticallyEnsureAdmin(); @@ -53,6 +55,7 @@ public async Task BulkRequeueEmailOutbox([FromBody] Em [HttpPost("email/outbox/bulk/cancel")] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] + [ApiVersion(1)] public async Task BulkCancelEmailOutbox([FromBody] EmailOutboxBulkRequest body, CancellationToken ct) { PedanticallyEnsureAdmin(); @@ -75,6 +78,7 @@ public async Task BulkCancelEmailOutbox([FromBody] Ema [HttpPost("email/outbox/bulk/delete")] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] + [ApiVersion(1)] public async Task BulkDeleteEmailOutbox([FromBody] EmailOutboxBulkRequest body, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/EmailOutboxCancel.cs b/API/Controller/Admin/EmailOutboxCancel.cs index 0bec336f9..49c5920dd 100644 --- a/API/Controller/Admin/EmailOutboxCancel.cs +++ b/API/Controller/Admin/EmailOutboxCancel.cs @@ -1,6 +1,7 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.Common.OpenShockDb; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; @@ -18,6 +19,7 @@ public sealed partial class AdminController [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] [ProducesResponseType(StatusCodes.Status409Conflict)] + [ApiVersion(1)] public async Task CancelEmailOutbox([FromRoute] Guid id, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/EmailOutboxDelete.cs b/API/Controller/Admin/EmailOutboxDelete.cs index 19bd972eb..5f2f2019c 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; @@ -15,6 +16,7 @@ public sealed partial class AdminController [HttpDelete("email/outbox/{id}")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] + [ApiVersion(1)] public async Task DeleteEmailOutbox([FromRoute] Guid id, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/EmailOutboxList.cs b/API/Controller/Admin/EmailOutboxList.cs index de9501f5a..01204ab10 100644 --- a/API/Controller/Admin/EmailOutboxList.cs +++ b/API/Controller/Admin/EmailOutboxList.cs @@ -9,6 +9,7 @@ using OpenShock.Internal.DynamicLinq.Query; using System.ComponentModel.DataAnnotations; using System.Net.Mime; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; @@ -23,6 +24,7 @@ public sealed partial class AdminController /// Unauthorized [HttpGet("email/outbox")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] + [ApiVersion(1)] public async Task GetEmailOutbox( [FromQuery(Name = "$filter")] string filterQuery = "", [FromQuery(Name = "$orderby")] string orderbyQuery = "", diff --git a/API/Controller/Admin/EmailOutboxRequeue.cs b/API/Controller/Admin/EmailOutboxRequeue.cs index fa2a89206..f4da2f233 100644 --- a/API/Controller/Admin/EmailOutboxRequeue.cs +++ b/API/Controller/Admin/EmailOutboxRequeue.cs @@ -2,6 +2,7 @@ using Microsoft.EntityFrameworkCore; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Services.RedisPubSub; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; @@ -19,6 +20,7 @@ public sealed partial class AdminController [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] [ProducesResponseType(StatusCodes.Status409Conflict)] + [ApiVersion(1)] public async Task RequeueEmailOutbox([FromRoute] Guid id, [FromServices] IRedisPubService redisPubService, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/EmailOutboxStats.cs b/API/Controller/Admin/EmailOutboxStats.cs index 18b2918b9..5c2440dc8 100644 --- a/API/Controller/Admin/EmailOutboxStats.cs +++ b/API/Controller/Admin/EmailOutboxStats.cs @@ -3,6 +3,7 @@ using OpenShock.API.Controller.Admin.DTOs; using OpenShock.Common.OpenShockDb; using System.Net.Mime; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; @@ -15,6 +16,7 @@ public sealed partial class AdminController /// Unauthorized [HttpGet("email/outbox/stats")] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] + [ApiVersion(1)] public async Task GetEmailOutboxStats() { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/EmailOutboxTestSend.cs b/API/Controller/Admin/EmailOutboxTestSend.cs index 24ddf143b..f487d2dbd 100644 --- a/API/Controller/Admin/EmailOutboxTestSend.cs +++ b/API/Controller/Admin/EmailOutboxTestSend.cs @@ -3,6 +3,7 @@ using OpenShock.API.Controller.Admin.DTOs; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Services.RedisPubSub; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; @@ -20,6 +21,7 @@ public sealed partial class AdminController [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status400BadRequest)] + [ApiVersion(1)] public async Task SendTestEmail([FromBody] SendTestEmailDto body, [FromServices] IRedisPubService redisPubService, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/EmailProviderBlacklistAdd.cs b/API/Controller/Admin/EmailProviderBlacklistAdd.cs index 709a0dd19..d2cdec157 100644 --- a/API/Controller/Admin/EmailProviderBlacklistAdd.cs +++ b/API/Controller/Admin/EmailProviderBlacklistAdd.cs @@ -3,6 +3,7 @@ using Microsoft.EntityFrameworkCore; using OpenShock.API.Controller.Admin.DTOs; using OpenShock.Common.OpenShockDb; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; @@ -11,6 +12,7 @@ public sealed partial class AdminController [HttpPost("blacklist/emailProviders")] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] + [ApiVersion(1)] public async Task AddEmailProviderBlacklist([FromBody] AddEmailProviderBlacklistDto body, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/EmailProviderBlacklistList.cs b/API/Controller/Admin/EmailProviderBlacklistList.cs index fa9355bcc..dbb91d302 100644 --- a/API/Controller/Admin/EmailProviderBlacklistList.cs +++ b/API/Controller/Admin/EmailProviderBlacklistList.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/emailProviders")] + [ApiVersion(1)] public async IAsyncEnumerable ListEmailProviderBlacklist([FromQuery(Name="match")] string? match) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/EmailProviderBlacklistRemove.cs b/API/Controller/Admin/EmailProviderBlacklistRemove.cs index 668f5d0c5..eaa0fb052 100644 --- a/API/Controller/Admin/EmailProviderBlacklistRemove.cs +++ b/API/Controller/Admin/EmailProviderBlacklistRemove.cs @@ -1,5 +1,6 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; @@ -8,6 +9,7 @@ public sealed partial class AdminController [HttpDelete("blacklist/emailProviders/{id}")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] + [ApiVersion(1)] public async Task RemoveEmailProviderBlacklist([FromRoute] Guid id, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/GetAuditLog.cs b/API/Controller/Admin/GetAuditLog.cs index b3facc996..b352aa9a3 100644 --- a/API/Controller/Admin/GetAuditLog.cs +++ b/API/Controller/Admin/GetAuditLog.cs @@ -4,6 +4,7 @@ using OpenShock.API.Models.Response; using OpenShock.Common.Services.Audit; using OpenShock.Common.Utils.Pagination; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; @@ -20,6 +21,7 @@ public sealed partial class AdminController /// A page of audit log entries. [HttpGet("audit-log")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] + [ApiVersion(1)] public async Task> GetAdminAuditLog( [FromQuery] PaginationQuery pagination, [FromQuery] Guid? userId, diff --git a/API/Controller/Admin/GetOnlineDevices.cs b/API/Controller/Admin/GetOnlineDevices.cs index 6bd47b0e7..850f546f9 100644 --- a/API/Controller/Admin/GetOnlineDevices.cs +++ b/API/Controller/Admin/GetOnlineDevices.cs @@ -7,6 +7,8 @@ using System.Text.Json.Serialization; using OpenShock.Common.JsonSerialization; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController @@ -18,6 +20,7 @@ public sealed partial class AdminController /// Unauthorized [HttpGet("monitoring/onlineDevices")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] + [ApiVersion(1)] public async Task GetOnlineDevices() { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/GetUsers.cs b/API/Controller/Admin/GetUsers.cs index 7611aacd5..98e147c47 100644 --- a/API/Controller/Admin/GetUsers.cs +++ b/API/Controller/Admin/GetUsers.cs @@ -11,6 +11,8 @@ using OpenShock.Internal.DynamicLinq.Extensions; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController @@ -22,6 +24,7 @@ public sealed partial class AdminController /// Unauthorized [HttpGet("users")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] + [ApiVersion(1)] public async Task GetUsers( [FromQuery(Name = "$filter")] string filterQuery = "", [FromQuery(Name = "$orderby")] string orderbyQuery = "", diff --git a/API/Controller/Admin/PatchUser.cs b/API/Controller/Admin/PatchUser.cs index 6346eefff..fadcc1bbe 100644 --- a/API/Controller/Admin/PatchUser.cs +++ b/API/Controller/Admin/PatchUser.cs @@ -3,6 +3,8 @@ using OpenShock.API.Controller.Admin.DTOs; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController @@ -16,6 +18,7 @@ public sealed partial class AdminController [HttpPatch("users/{userId}")] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] + [ApiVersion(1)] public async Task ModifyUser([FromRoute] Guid userId, [FromBody] UserPatchDto body, [FromServices] IAccountService accountService, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/ReactivateUser.cs b/API/Controller/Admin/ReactivateUser.cs index 89f6ed407..74c16a62d 100644 --- a/API/Controller/Admin/ReactivateUser.cs +++ b/API/Controller/Admin/ReactivateUser.cs @@ -7,6 +7,8 @@ using AccountSvc = OpenShock.API.Services.Account; using Results = OpenShock.Common.Results; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController @@ -18,6 +20,7 @@ public sealed partial class AdminController /// Unauthorized [HttpPut("users/{userId}/reactivate")] [ProducesResponseType(StatusCodes.Status200OK)] + [ApiVersion(1)] public async Task ReactivateUser( [FromRoute] Guid userId, [FromQuery][MaxLength(ApiHardLimits.AuditReasonMaxLength)] string? reason, diff --git a/API/Controller/Admin/UserNameBlacklistAdd.cs b/API/Controller/Admin/UserNameBlacklistAdd.cs index 4f6d477bf..257803d5d 100644 --- a/API/Controller/Admin/UserNameBlacklistAdd.cs +++ b/API/Controller/Admin/UserNameBlacklistAdd.cs @@ -2,6 +2,7 @@ using Microsoft.AspNetCore.Mvc; using OpenShock.API.Controller.Admin.DTOs; using OpenShock.Common.OpenShockDb; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; @@ -10,6 +11,7 @@ public sealed partial class AdminController [HttpPost("blacklist/usernames")] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] + [ApiVersion(1)] public async Task AddUsernameBlacklist([FromBody] AddUsernameBlacklistDto body) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/UserNameBlacklistList.cs b/API/Controller/Admin/UserNameBlacklistList.cs index 66e4bca30..cdc18e25a 100644 --- a/API/Controller/Admin/UserNameBlacklistList.cs +++ b/API/Controller/Admin/UserNameBlacklistList.cs @@ -1,12 +1,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) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/UserNameBlacklistRemove.cs b/API/Controller/Admin/UserNameBlacklistRemove.cs index 54c08d066..53f58e678 100644 --- a/API/Controller/Admin/UserNameBlacklistRemove.cs +++ b/API/Controller/Admin/UserNameBlacklistRemove.cs @@ -1,5 +1,6 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; @@ -8,6 +9,7 @@ public sealed partial class AdminController [HttpDelete("blacklist/usernames/{id}")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] + [ApiVersion(1)] public async Task RemoveUsernameBlacklist([FromRoute] Guid id, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/WebhookAdd.cs b/API/Controller/Admin/WebhookAdd.cs index e8bee8bcb..9b8c10b65 100644 --- a/API/Controller/Admin/WebhookAdd.cs +++ b/API/Controller/Admin/WebhookAdd.cs @@ -6,6 +6,8 @@ using OpenShock.Common.Results; using OpenShock.Common.Services.Webhook; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController @@ -19,6 +21,7 @@ public sealed partial class AdminController [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] + [ApiVersion(1)] public async Task AddWebhook([FromBody] AddWebhookDto body, [FromServices] IWebhookService webhookService) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/WebhookList.cs b/API/Controller/Admin/WebhookList.cs index abbf89612..b0286b3a9 100644 --- a/API/Controller/Admin/WebhookList.cs +++ b/API/Controller/Admin/WebhookList.cs @@ -2,6 +2,8 @@ using OpenShock.Common.Models; using OpenShock.Common.Services.Webhook; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController @@ -12,6 +14,7 @@ public sealed partial class AdminController /// OK /// Unauthorized [HttpGet("webhooks")] + [ApiVersion(1)] public async Task ListWebhooks([FromServices] IWebhookService webhookService) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/WebhookRemove.cs b/API/Controller/Admin/WebhookRemove.cs index 71b73f055..ab41be2b5 100644 --- a/API/Controller/Admin/WebhookRemove.cs +++ b/API/Controller/Admin/WebhookRemove.cs @@ -2,6 +2,8 @@ using OpenShock.Common.Errors; using OpenShock.Common.Services.Webhook; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController @@ -14,6 +16,7 @@ public sealed partial class AdminController [HttpDelete("webhooks/{id}")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] + [ApiVersion(1)] public async Task RemoveWebhook([FromRoute] Guid id, [FromServices] IWebhookService webhookService) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Device/AssignLCG.cs b/API/Controller/Device/AssignLCG.cs index cac43819d..046d5ba92 100644 --- a/API/Controller/Device/AssignLCG.cs +++ b/API/Controller/Device/AssignLCG.cs @@ -1,7 +1,7 @@ using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Response; using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using OpenShock.API.Services.LCGNodeProvisioner; using OpenShock.Common.Errors; using OpenShock.Common.Problems; @@ -20,7 +20,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) diff --git a/API/Controller/Device/AssignLCGV2.cs b/API/Controller/Device/AssignLCGV2.cs index 5cb863b84..f5a0c8914 100644 --- a/API/Controller/Device/AssignLCGV2.cs +++ b/API/Controller/Device/AssignLCGV2.cs @@ -1,7 +1,7 @@ using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Response; using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using OpenShock.API.Services.LCGNodeProvisioner; using OpenShock.Common.Errors; using OpenShock.Common.Problems; @@ -19,7 +19,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 8ddaf3edd..6c27c7162 100644 --- a/API/Controller/Device/GetSelf.cs +++ b/API/Controller/Device/GetSelf.cs @@ -1,5 +1,5 @@ using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; @@ -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() { diff --git a/API/Controller/Device/Pair.cs b/API/Controller/Device/Pair.cs index 061f9ebef..c1bae357e 100644 --- a/API/Controller/Device/Pair.cs +++ b/API/Controller/Device/Pair.cs @@ -3,7 +3,7 @@ using Microsoft.EntityFrameworkCore; using OpenShock.Common.Redis; using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.RateLimiting; using OpenShock.Common.Errors; using OpenShock.Common.Problems; @@ -22,7 +22,7 @@ public sealed partial class DeviceController /// Successfully assigned LCG node /// No such pair code exists [AllowAnonymous] - [MapToApiVersion("1")] + [ApiVersion(1)] [HttpGet("pair/{pairCode}", Name = "Pair")] [EndpointName("PairDeviceByCode")] [EnableRateLimiting("auth")] @@ -37,7 +37,7 @@ public async Task Pair([FromRoute] string pairCode) /// Pair a device with a pair code, legacy endpoint kept for backwards compatibility /// [AllowAnonymous] - [MapToApiVersion("1")] + [ApiVersion(1)] [HttpGet("~/{version:apiVersion}/pair/{pairCode}")] [ApiExplorerSettings(IgnoreApi = true)] [EnableRateLimiting("auth")] diff --git a/API/Controller/Device/_ApiController.cs b/API/Controller/Device/_ApiController.cs index 270b6a40d..b4727c694 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 221fda682..03e831c6b 100644 --- a/API/Controller/Devices/DeviceOtaController.cs +++ b/API/Controller/Devices/DeviceOtaController.cs @@ -1,5 +1,4 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; @@ -14,11 +13,12 @@ using OpenShock.Internal.Common.Problems; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Devices; [ApiController] [Tags("Hub Management")] -[ApiVersion("1")] [Route("/{version:apiVersion}/devices")] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.UserSessionCookie)] public sealed class DevicesOtaController : AuthenticatedSessionControllerBase @@ -40,9 +40,9 @@ public DevicesOtaController(OpenShockContext db, ILogger logg /// OK /// Could not find device or you do not have access to it [HttpGet("{deviceId}/ota")] - [MapToApiVersion("1")] [ProducesResponseType>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound + [ApiVersion(1)] public async Task GetOtaUpdateHistory([FromRoute] Guid deviceId, [FromServices] IOtaService otaService) { // Check if user owns device or has a share diff --git a/API/Controller/Devices/DevicesController.cs b/API/Controller/Devices/DevicesController.cs index 3a634ae3e..af82501d8 100644 --- a/API/Controller/Devices/DevicesController.cs +++ b/API/Controller/Devices/DevicesController.cs @@ -1,6 +1,6 @@ using System.Net.Mime; using System.Security.Cryptography; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; @@ -33,7 +33,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() { @@ -58,7 +58,7 @@ public IActionResult ListDevices() [HttpGet("{deviceId}")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task GetDeviceById([FromRoute] Guid deviceId) { var hasAuthPerms = IsAllowed(PermissionType.Devices_Auth); @@ -90,7 +90,7 @@ public async Task GetDeviceById([FromRoute] Guid deviceId) [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task EditDevice([FromRoute] Guid deviceId, [FromBody] HubEditRequest body, [FromServices] IDeviceUpdateService updateService) { var device = await _db.Devices.FirstOrDefaultAsync(x => x.OwnerId == CurrentUser.Id && x.Id == deviceId); @@ -115,7 +115,7 @@ public async Task EditDevice([FromRoute] Guid deviceId, [FromBody [TokenPermission(PermissionType.Devices_Edit)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Text.Plain)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task RegenerateDeviceToken([FromRoute] Guid deviceId) { var device = await _db.Devices.FirstOrDefaultAsync(x => x.OwnerId == CurrentUser.Id && x.Id == deviceId); @@ -140,7 +140,7 @@ public async Task RegenerateDeviceToken([FromRoute] Guid deviceId [TokenPermission(PermissionType.Devices_Edit)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task RemoveDevice([FromRoute] Guid deviceId, [FromServices] IDeviceUpdateService updateService) { var affected = await _db.Devices.Where(x => x.Id == deviceId).WhereIsUserOrPrivileged(x => x.Owner, CurrentUser).ExecuteDeleteAsync(); @@ -158,7 +158,7 @@ public async Task RemoveDevice([FromRoute] Guid deviceId, [FromSe [HttpPost] [TokenPermission(PermissionType.Devices_Edit)] [ProducesResponseType(StatusCodes.Status201Created, MediaTypeNames.Text.Plain)] - [MapToApiVersion("1")] + [ApiVersion(1)] public Task CreateDevice([FromServices] IDeviceUpdateService updateService) => CreateDeviceV2(new HubCreateRequest { @@ -174,7 +174,7 @@ public Task CreateDevice([FromServices] IDeviceUpdateService upda [TokenPermission(PermissionType.Devices_Edit)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status201Created, MediaTypeNames.Text.Plain)] - [MapToApiVersion("2")] + [ApiVersion(2)] public async Task CreateDeviceV2([FromBody] HubCreateRequest body, [FromServices] IDeviceUpdateService updateService) { int nDevices = await _db.Devices.CountAsync(d => d.OwnerId == CurrentUser.Id); @@ -208,7 +208,7 @@ public async Task CreateDeviceV2([FromBody] HubCreateRequest body [TokenPermission(PermissionType.Devices_Edit)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task GetPairCode([FromRoute] Guid deviceId) { var devicePairs = _redis.RedisCollection(); @@ -239,7 +239,7 @@ public async Task GetPairCode([FromRoute] Guid deviceId) [HttpGet("{deviceId}/lcg")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound, DeviceIsNotOnline - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task GetLiveControlGatewayInfo([FromRoute] Guid deviceId) { var result = await ResolveDeviceGatewayAsync(deviceId); @@ -261,7 +261,7 @@ public async Task GetLiveControlGatewayInfo([FromRoute] Guid devi [HttpGet("{deviceId}/lcg")] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound, DeviceIsNotOnline - [MapToApiVersion("2")] + [ApiVersion(2)] public async Task GetLiveControlGatewayInfoV2([FromRoute] Guid deviceId) { var result = await ResolveDeviceGatewayAsync(deviceId); diff --git a/API/Controller/Devices/GetShockers.cs b/API/Controller/Devices/GetShockers.cs index 54fbf8e24..f194b22b7 100644 --- a/API/Controller/Devices/GetShockers.cs +++ b/API/Controller/Devices/GetShockers.cs @@ -2,7 +2,7 @@ using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Problems; using OpenShock.Common.Models; @@ -22,7 +22,7 @@ public sealed partial class DevicesController [HttpGet("{deviceId}/shockers")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task GetShockers([FromRoute] Guid deviceId) { var deviceExists = await _db.Devices.AnyAsync(x => x.OwnerId == CurrentUser.Id && x.Id == deviceId); diff --git a/API/Controller/Devices/_ApiController.cs b/API/Controller/Devices/_ApiController.cs index c123f6f39..90ff35d3c 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/OAuth/Authorize.cs b/API/Controller/OAuth/Authorize.cs index 05de0fdd8..b8f4905a0 100644 --- a/API/Controller/OAuth/Authorize.cs +++ b/API/Controller/OAuth/Authorize.cs @@ -1,3 +1,4 @@ +using OpenShock.Common.ApiVersioning; using System.ComponentModel.DataAnnotations; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; @@ -19,6 +20,7 @@ public sealed partial class OAuthController /// Redirect to the provider authorization page. /// Unsupported or misconfigured provider. [EnableRateLimiting("auth")] + [ApiVersion(1)] [HttpPost("{provider}/authorize")] [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 ccff2fc3e..c4ba1958f 100644 --- a/API/Controller/OAuth/HandOff.cs +++ b/API/Controller/OAuth/HandOff.cs @@ -1,4 +1,5 @@ -using System.Security.Claims; +using OpenShock.Common.ApiVersioning; +using System.Security.Claims; using Microsoft.AspNetCore.Authentication; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; @@ -20,6 +21,7 @@ public sealed partial class OAuthController /// Otherwise -> redirects frontend to continue the chosen flow. /// [EnableRateLimiting("auth")] + [ApiVersion(1)] [HttpGet("{provider}/handoff")] [ApiExplorerSettings(IgnoreApi = true)] public async Task OAuthHandOff( diff --git a/API/Controller/OAuth/SignupFinalize.cs b/API/Controller/OAuth/SignupFinalize.cs index 3acee31c4..cf0de9e7b 100644 --- a/API/Controller/OAuth/SignupFinalize.cs +++ b/API/Controller/OAuth/SignupFinalize.cs @@ -1,4 +1,5 @@ -using Microsoft.AspNetCore.Authentication; +using OpenShock.Common.ApiVersioning; +using Microsoft.AspNetCore.Authentication; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.Models.Requests; @@ -29,6 +30,7 @@ public sealed partial class OAuthController /// /// [EnableRateLimiting("auth")] + [ApiVersion(1)] [HttpPost("{provider}/signup-finalize")] [ApiExplorerSettings(IgnoreApi = true)] public async Task OAuthSignupFinalize( diff --git a/API/Controller/OAuth/SignupGetData.cs b/API/Controller/OAuth/SignupGetData.cs index 7fcb82cbc..f58a8b64d 100644 --- a/API/Controller/OAuth/SignupGetData.cs +++ b/API/Controller/OAuth/SignupGetData.cs @@ -1,4 +1,5 @@ -using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; +using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.Models.Response; using OpenShock.API.OAuth; @@ -21,6 +22,7 @@ public sealed partial class OAuthController /// The provider key (e.g. discord). [ResponseCache(NoStore = true)] [EnableRateLimiting("auth")] + [ApiVersion(1)] [HttpGet("{provider}/signup-data")] [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 e575d196f..a2874254a 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 ff07f15cb..314983f5f 100644 --- a/API/Controller/Public/GetStats.cs +++ b/API/Controller/Public/GetStats.cs @@ -1,4 +1,5 @@ -using System.Net.Mime; +using OpenShock.Common.ApiVersioning; +using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using NRedisStack.RedisStackCommands; using OpenShock.Common.Models; @@ -14,6 +15,7 @@ public sealed partial class PublicController /// /// The statistics were successfully retrieved. [Tags("Meta")] + [ApiVersion(1)] [HttpGet("stats")] [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 cfb7b43bc..6ac4dbe3d 100644 --- a/API/Controller/Public/PublicShareController.cs +++ b/API/Controller/Public/PublicShareController.cs @@ -1,4 +1,5 @@ -using System.Net.Mime; +using OpenShock.Common.ApiVersioning; +using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; @@ -20,6 +21,7 @@ public sealed partial class PublicController /// /// The public share information was successfully retrieved. /// The public share does not exist. + [ApiVersion(1)] [HttpGet("shares/links/{publicShareId}")] [Tags("Public Shocker Shares")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] diff --git a/API/Controller/Sessions/DeleteSessions.cs b/API/Controller/Sessions/DeleteSessions.cs index 31b5c4d28..82bd068ac 100644 --- a/API/Controller/Sessions/DeleteSessions.cs +++ b/API/Controller/Sessions/DeleteSessions.cs @@ -7,6 +7,8 @@ using OpenShock.Internal.Common.Problems; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Sessions; public sealed partial class SessionsController @@ -14,6 +16,7 @@ public sealed partial class SessionsController [HttpDelete("{sessionId}")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // SessionNotFound + [ApiVersion(1)] public async Task DeleteSession([FromRoute] Guid sessionId) { var loginSession = await _sessionService.GetSessionByIdAsync(sessionId); diff --git a/API/Controller/Sessions/ListSessions.cs b/API/Controller/Sessions/ListSessions.cs index 964b1c260..6e8157879 100644 --- a/API/Controller/Sessions/ListSessions.cs +++ b/API/Controller/Sessions/ListSessions.cs @@ -2,12 +2,15 @@ using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Sessions; public sealed partial class SessionsController { [HttpGet] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] + [ApiVersion(1)] public IAsyncEnumerable ListSessions() { return _sessionService.ListSessionsByUserIdAsync(CurrentUser.Id) diff --git a/API/Controller/Sessions/SessionSelf.cs b/API/Controller/Sessions/SessionSelf.cs index bf54fb185..4fad39026 100644 --- a/API/Controller/Sessions/SessionSelf.cs +++ b/API/Controller/Sessions/SessionSelf.cs @@ -4,6 +4,8 @@ using OpenShock.Common.Authentication.Services; using OpenShock.Common.Redis; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Sessions; public sealed partial class SessionsController @@ -12,9 +14,9 @@ public sealed partial class SessionsController /// Gets information about the current token used to access this endpoint /// /// - /// /// [HttpGet("self")] + [ApiVersion(1)] public LoginSessionResponse GetSelfSession([FromServices] IUserReferenceService userReferenceService) { if (userReferenceService.AuthReference is not LoginSession session) diff --git a/API/Controller/Sessions/_ApiController.cs b/API/Controller/Sessions/_ApiController.cs index d86febb1e..be122e6a3 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 af9032868..ebf094c23 100644 --- a/API/Controller/Shares/DeleteShareCode.cs +++ b/API/Controller/Shares/DeleteShareCode.cs @@ -1,5 +1,4 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.Common.Errors; @@ -9,6 +8,8 @@ using OpenShock.Internal.Common.Problems; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Shares; public sealed partial class SharesController @@ -22,7 +23,7 @@ public sealed partial class SharesController [HttpDelete("code/{shareCodeId}")] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShareCodeNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task DeleteShareCode([FromRoute] Guid shareCodeId) { var affected = await _db.ShockerShareCodes diff --git a/API/Controller/Shares/LinkShareCode.cs b/API/Controller/Shares/LinkShareCode.cs index 035881d8a..ba3dde082 100644 --- a/API/Controller/Shares/LinkShareCode.cs +++ b/API/Controller/Shares/LinkShareCode.cs @@ -1,5 +1,4 @@ using System.Net.Mime; -using Asp.Versioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Services.DeviceUpdate; @@ -10,6 +9,8 @@ using OpenShock.Internal.Common.Problems; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Shares; public sealed partial class SharesController @@ -27,7 +28,7 @@ public sealed partial class SharesController [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShareCodeNotFound [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // CantLinkOwnShareCode, ShockerAlreadyLinked - [MapToApiVersion("1")] + [ApiVersion(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 039b0b202..dc7c87099 100644 --- a/API/Controller/Shares/Links/AddShocker.cs +++ b/API/Controller/Shares/Links/AddShocker.cs @@ -1,4 +1,5 @@ -using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; +using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.Common.OpenShockDb; using System.Net.Mime; @@ -21,6 +22,7 @@ public sealed partial class ShareLinksController /// Successfully added shocker /// Public share or shocker does not exist /// Shocker already exists in public share + [ApiVersion(1)] [HttpPost("{publicShareId}/{shockerId}")] [TokenPermission(PermissionType.Publicshares_Edit)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] diff --git a/API/Controller/Shares/Links/CreatePublicShare.cs b/API/Controller/Shares/Links/CreatePublicShare.cs index 2c02b4e8b..1e6f2e007 100644 --- a/API/Controller/Shares/Links/CreatePublicShare.cs +++ b/API/Controller/Shares/Links/CreatePublicShare.cs @@ -1,4 +1,5 @@ -using System.Net.Mime; +using OpenShock.Common.ApiVersioning; +using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Requests; using OpenShock.Common.Authentication.Attributes; @@ -14,6 +15,7 @@ public sealed partial class ShareLinksController /// Create a new public share /// /// The created public share + [ApiVersion(1)] [HttpPost(Name = "CreatePublicShare")] [TokenPermission(PermissionType.Publicshares_Edit)] [Consumes(MediaTypeNames.Application.Json)] diff --git a/API/Controller/Shares/Links/DeletePublicShare.cs b/API/Controller/Shares/Links/DeletePublicShare.cs index eec3efcdb..0c8088be9 100644 --- a/API/Controller/Shares/Links/DeletePublicShare.cs +++ b/API/Controller/Shares/Links/DeletePublicShare.cs @@ -1,4 +1,5 @@ -using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; +using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using System.Net.Mime; using OpenShock.Common.Authentication.Attributes; @@ -20,6 +21,7 @@ public sealed partial class ShareLinksController /// /// Deleted public share /// Public share not found or does not belong to you + [ApiVersion(1)] [HttpDelete("{publicShareId}")] [TokenPermission(PermissionType.Publicshares_Edit)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] diff --git a/API/Controller/Shares/Links/EditShocker.cs b/API/Controller/Shares/Links/EditShocker.cs index b30adc8bc..e4a9a2dd2 100644 --- a/API/Controller/Shares/Links/EditShocker.cs +++ b/API/Controller/Shares/Links/EditShocker.cs @@ -1,4 +1,5 @@ -using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; +using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; using System.Net.Mime; @@ -22,6 +23,7 @@ public sealed partial class ShareLinksController /// Successfully updated shocker /// Public share or shocker does not exist /// Shocker does not exist in public share + [ApiVersion(1)] [HttpPatch("{publicShareId}/{shockerId}")] [Consumes(MediaTypeNames.Application.Json)] [TokenPermission(PermissionType.Publicshares_Edit)] diff --git a/API/Controller/Shares/Links/List.cs b/API/Controller/Shares/Links/List.cs index 1908c6218..06d4d44c7 100644 --- a/API/Controller/Shares/Links/List.cs +++ b/API/Controller/Shares/Links/List.cs @@ -1,4 +1,5 @@ -using System.Net.Mime; +using OpenShock.Common.ApiVersioning; +using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; @@ -14,6 +15,7 @@ public sealed partial class ShareLinksController /// Get all public shares for the current user /// /// All public shares for the current user + [ApiVersion(1)] [HttpGet] [TokenPermission(PermissionType.Publicshares_Edit)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] diff --git a/API/Controller/Shares/Links/PauseShocker.cs b/API/Controller/Shares/Links/PauseShocker.cs index a350cd3d9..cc65e4f7c 100644 --- a/API/Controller/Shares/Links/PauseShocker.cs +++ b/API/Controller/Shares/Links/PauseShocker.cs @@ -1,4 +1,5 @@ -using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; +using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; using OpenShock.API.Utils; @@ -24,6 +25,7 @@ public sealed partial class ShareLinksController /// Successfully updated paused state shocker /// Public share or shocker does not exist /// Shocker does not exist in public share + [ApiVersion(1)] [HttpPost("{publicShareId}/{shockerId}/pause")] [Consumes(MediaTypeNames.Application.Json)] [TokenPermission(PermissionType.Publicshares_Pause)] diff --git a/API/Controller/Shares/Links/RemoveShocker.cs b/API/Controller/Shares/Links/RemoveShocker.cs index c452d5d5a..0f40988f2 100644 --- a/API/Controller/Shares/Links/RemoveShocker.cs +++ b/API/Controller/Shares/Links/RemoveShocker.cs @@ -1,4 +1,5 @@ -using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; +using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using System.Net.Mime; using OpenShock.Common.Authentication.Attributes; @@ -22,6 +23,7 @@ public sealed partial class ShareLinksController /// Successfully removed shocker /// Public share or shocker does not exist /// Shocker does not exist in public share + [ApiVersion(1)] [HttpDelete("{publicShareId}/{shockerId}")] [TokenPermission(PermissionType.Publicshares_Edit)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] diff --git a/API/Controller/Shares/UserShares/CreateShareInvite.cs b/API/Controller/Shares/UserShares/CreateShareInvite.cs index 44fb896d8..e0a009760 100644 --- a/API/Controller/Shares/UserShares/CreateShareInvite.cs +++ b/API/Controller/Shares/UserShares/CreateShareInvite.cs @@ -1,5 +1,5 @@ using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; @@ -21,7 +21,7 @@ public sealed partial class UserSharesController [TokenPermission(PermissionType.Usershares_Edit)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // UserNotFound, ShareCreateShockerNotFound [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // ShareCreateCannotShareWithSelf - [MapToApiVersion("2")] + [ApiVersion(2)] public async Task CreateShareInvite([FromBody] CreateShareRequest body) { if (body.User == CurrentUser.Id) diff --git a/API/Controller/Shares/UserShares/GetShares.cs b/API/Controller/Shares/UserShares/GetShares.cs index fbbd1b347..348657e59 100644 --- a/API/Controller/Shares/UserShares/GetShares.cs +++ b/API/Controller/Shares/UserShares/GetShares.cs @@ -1,4 +1,4 @@ -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; @@ -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 dc6c8851d..63424d132 100644 --- a/API/Controller/Shares/UserShares/Invites.cs +++ b/API/Controller/Shares/UserShares/Invites.cs @@ -1,5 +1,5 @@ using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; @@ -62,7 +62,7 @@ public sealed partial class UserSharesController { [HttpGet("invites/outgoing")] [TokenPermission(PermissionType.Usershares_Edit)] - [MapToApiVersion("2")] + [ApiVersion(2)] public IAsyncEnumerable GetOutgoingInvitesList() { return _db.UserShareInvites @@ -73,7 +73,7 @@ public IAsyncEnumerable GetOutgoingInvitesList() [HttpGet("invites/incoming")] [TokenPermission(PermissionType.Usershares_Edit)] - [MapToApiVersion("2")] + [ApiVersion(2)] public IAsyncEnumerable GetIncomingInvitesList() { return _db.UserShareInvites @@ -86,7 +86,7 @@ public IAsyncEnumerable GetIncomingInvitesList() [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShareRequestNotFound [TokenPermission(PermissionType.Usershares_Edit)] - [MapToApiVersion("2")] + [ApiVersion(2)] public async Task DeleteOutgoingInvite([FromRoute] Guid inviteId) { var deletedShareRequest = await _db.UserShareInvites @@ -101,7 +101,7 @@ public async Task DeleteOutgoingInvite([FromRoute] Guid inviteId) [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShareRequestNotFound [TokenPermission(PermissionType.Usershares_Edit)] - [MapToApiVersion("2")] + [ApiVersion(2)] public async Task DenyIncomingInvite([FromRoute] Guid inviteId) { var deletedShareRequest = await _db.UserShareInvites @@ -117,12 +117,11 @@ public async Task DenyIncomingInvite([FromRoute] Guid inviteId) /// /// /// - /// [HttpPost("invites/incoming/{inviteId}")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShareRequestNotFound [TokenPermission(PermissionType.Usershares_Edit)] - [MapToApiVersion("2")] + [ApiVersion(2)] public async Task RedeemInvite([FromRoute] Guid inviteId, [FromServices] IDeviceUpdateService deviceUpdateService) { var shareRequest = await _db.UserShareInvites diff --git a/API/Controller/Shares/UserShares/PauseShockerShares.cs b/API/Controller/Shares/UserShares/PauseShockerShares.cs index 6cc3f9607..febcc74bd 100644 --- a/API/Controller/Shares/UserShares/PauseShockerShares.cs +++ b/API/Controller/Shares/UserShares/PauseShockerShares.cs @@ -1,5 +1,5 @@ using System.ComponentModel.DataAnnotations; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Services.DeviceUpdate; @@ -15,7 +15,7 @@ public sealed partial class UserSharesController { [HttpPost("{userId:guid}/shockers/pause")] [TokenPermission(PermissionType.Usershares_Pause)] - [MapToApiVersion("2")] + [ApiVersion(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 010619439..ba10ec483 100644 --- a/API/Controller/Shares/UserShares/RemoveShockerShares.cs +++ b/API/Controller/Shares/UserShares/RemoveShockerShares.cs @@ -1,5 +1,5 @@ using System.ComponentModel.DataAnnotations; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Services.DeviceUpdate; @@ -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) diff --git a/API/Controller/Shares/UserShares/UpdateShockerShares.cs b/API/Controller/Shares/UserShares/UpdateShockerShares.cs index d47e75031..dcfdc4835 100644 --- a/API/Controller/Shares/UserShares/UpdateShockerShares.cs +++ b/API/Controller/Shares/UserShares/UpdateShockerShares.cs @@ -1,5 +1,5 @@ using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; @@ -30,7 +30,7 @@ public sealed partial class UserSharesController [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("2")] + [ApiVersion(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 c493800fb..bc70721ca 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 cf0d7e4f6..63c017a91 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 67622006a..7625ef58e 100644 --- a/API/Controller/Shockers/EditShocker.cs +++ b/API/Controller/Shockers/EditShocker.cs @@ -1,5 +1,5 @@ using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; @@ -29,7 +29,7 @@ public sealed partial class ShockerController [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound, ShockerNotFound - [MapToApiVersion("1")] + [ApiVersion(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 0148cd936..2d3dbdca7 100644 --- a/API/Controller/Shockers/GetShockerById.cs +++ b/API/Controller/Shockers/GetShockerById.cs @@ -1,5 +1,5 @@ using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; @@ -22,7 +22,7 @@ public sealed partial class ShockerController [HttpGet("{shockerId}")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task GetShockerById([FromRoute] Guid shockerId) { 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 a42a9140c..fd8e17962 100644 --- a/API/Controller/Shockers/GetShockerLogs.cs +++ b/API/Controller/Shockers/GetShockerLogs.cs @@ -1,6 +1,6 @@ using System.ComponentModel.DataAnnotations; using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; using Microsoft.EntityFrameworkCore; @@ -44,7 +44,7 @@ public sealed partial class ShockerController [EnableRateLimiting("shocker-logs")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task GetShockerLogs([FromRoute] Guid shockerId, [FromQuery(Name = "offset")] uint offset = 0, [FromQuery, Range(1, 500)] uint limit = 100) { @@ -95,7 +95,7 @@ public async Task GetShockerLogs([FromRoute] Guid shockerId, [Fro [HttpGet("logs")] [EnableRateLimiting("shocker-logs")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] - [MapToApiVersion("1")] + [ApiVersion(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 ae66098c1..4bbbb1066 100644 --- a/API/Controller/Shockers/ListSharedShockers.cs +++ b/API/Controller/Shockers/ListSharedShockers.cs @@ -1,5 +1,5 @@ using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; @@ -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() { diff --git a/API/Controller/Shockers/ListShockers.cs b/API/Controller/Shockers/ListShockers.cs index 4a6408ba2..105c2840c 100644 --- a/API/Controller/Shockers/ListShockers.cs +++ b/API/Controller/Shockers/ListShockers.cs @@ -1,5 +1,5 @@ using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; @@ -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 321b5978f..8bca55902 100644 --- a/API/Controller/Shockers/PauseShocker.cs +++ b/API/Controller/Shockers/PauseShocker.cs @@ -1,5 +1,5 @@ using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; @@ -29,7 +29,7 @@ public sealed partial class ShockerController [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task PauseShocker([FromRoute] Guid shockerId, [FromBody] PauseRequest body, [FromServices] IDeviceUpdateService deviceUpdateService) { diff --git a/API/Controller/Shockers/RegisterShocker.cs b/API/Controller/Shockers/RegisterShocker.cs index 000f83594..acaa7a9cf 100644 --- a/API/Controller/Shockers/RegisterShocker.cs +++ b/API/Controller/Shockers/RegisterShocker.cs @@ -1,5 +1,5 @@ using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; @@ -31,7 +31,7 @@ public sealed partial class ShockerController [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // TooManyShockers - [MapToApiVersion("1")] + [ApiVersion(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 94c2b3114..4e1178f2c 100644 --- a/API/Controller/Shockers/RemoveShocker.cs +++ b/API/Controller/Shockers/RemoveShocker.cs @@ -1,5 +1,5 @@ using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Services.DeviceUpdate; @@ -27,7 +27,7 @@ public sealed partial class ShockerController [TokenPermission(PermissionType.Shockers_Edit)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] + [ApiVersion(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 1330e1eb1..adb748471 100644 --- a/API/Controller/Shockers/SendControl.cs +++ b/API/Controller/Shockers/SendControl.cs @@ -1,6 +1,6 @@ using System.Diagnostics; using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.SignalR; using OpenShock.Common.Authentication.Attributes; @@ -24,7 +24,7 @@ public sealed partial class ShockerController /// Send a control message to shockers /// /// The control messages were successfully sent. - [MapToApiVersion("2")] + [ApiVersion(2)] [HttpPost("control")] [TokenPermission(PermissionType.Shockers_Use)] [Consumes(MediaTypeNames.Application.Json)] @@ -72,7 +72,7 @@ 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")] + [ApiVersion(1)] [HttpPost("control")] [TokenPermission(PermissionType.Shockers_Use)] [Consumes(MediaTypeNames.Application.Json)] diff --git a/API/Controller/Shockers/ShockerShares.cs b/API/Controller/Shockers/ShockerShares.cs index abb806f7c..e1b7b155e 100644 --- a/API/Controller/Shockers/ShockerShares.cs +++ b/API/Controller/Shockers/ShockerShares.cs @@ -1,4 +1,4 @@ -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; @@ -27,7 +27,7 @@ public sealed partial class ShockerController [HttpGet("{shockerId}/shares")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task GetUserShares([FromRoute] Guid shockerId) { var owns = await _db.Shockers.AnyAsync(x => x.Device.OwnerId == CurrentUser.Id && x.Id == shockerId); @@ -73,7 +73,7 @@ public async Task GetUserShares([FromRoute] Guid shockerId) [HttpGet("{shockerId}/shareCodes")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task ShockerShareCodeList([FromRoute] Guid shockerId) { var owns = await _db.Shockers.AnyAsync(x => x.Device.OwnerId == CurrentUser.Id && x.Id == shockerId); @@ -105,13 +105,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")] [TokenPermission(PermissionType.Shockers_Edit)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task ShockerShareCodeCreate( [FromRoute] Guid shockerId, [FromBody] ShockerPermLimitPair body, @@ -154,7 +153,7 @@ [FromServices] IDeviceUpdateService deviceUpdateService [TokenPermission(PermissionType.Shockers_Edit)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task ShockerShareRemove( [FromRoute] Guid shockerId, [FromRoute] Guid sharedWithUserId, @@ -188,7 +187,7 @@ public async Task ShockerShareRemove( [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task ShockerShareCodeUpdate( [FromRoute] Guid shockerId, [FromRoute] Guid sharedWithUserId, @@ -232,7 +231,7 @@ public async Task ShockerShareCodeUpdate( [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ShockerNotFound - [MapToApiVersion("1")] + [ApiVersion(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 4b124d2a9..9d5a0e7bb 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 349dfea39..e97daaa7e 100644 --- a/API/Controller/Tokens/DeleteToken.cs +++ b/API/Controller/Tokens/DeleteToken.cs @@ -1,4 +1,5 @@ -using System.Net.Mime; +using OpenShock.Common.ApiVersioning; +using System.Net.Mime; using System.Security.Claims; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; @@ -36,6 +37,7 @@ public TokenDeleteController(IApiTokenService tokenService, ILoggerSuccessfully deleted token /// Api Token is not allowed to delete other Api Tokens /// The token does not exist, or you do not have access to it + [ApiVersion(1)] [HttpDelete("{tokenId}")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status403Forbidden)] diff --git a/API/Controller/Tokens/GetTokenSelf.cs b/API/Controller/Tokens/GetTokenSelf.cs index d20d3779f..d42a35e34 100644 --- a/API/Controller/Tokens/GetTokenSelf.cs +++ b/API/Controller/Tokens/GetTokenSelf.cs @@ -1,5 +1,5 @@ using System.Diagnostics; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models; @@ -15,17 +15,15 @@ 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([FromServices] IUserReferenceService userReferenceService) { return TokenResponse.MapFrom(GetSelfTokenV2(userReferenceService)); @@ -35,10 +33,9 @@ public TokenResponse GetSelfToken([FromServices] IUserReferenceService userRefer /// Gets information about the current token used to access this endpoint /// /// - /// /// [HttpGet("self")] - [MapToApiVersion("2")] + [ApiVersion(2)] public TokenResponseV2 GetSelfTokenV2([FromServices] IUserReferenceService userReferenceService) { var token = GetSelfTokenDto(userReferenceService); diff --git a/API/Controller/Tokens/ReportTokens.cs b/API/Controller/Tokens/ReportTokens.cs index dda6408e9..1da01ec0c 100644 --- a/API/Controller/Tokens/ReportTokens.cs +++ b/API/Controller/Tokens/ReportTokens.cs @@ -16,6 +16,8 @@ using OpenShock.Internal.Common.Problems; +using OpenShock.Common.ApiVersioning; + namespace OpenShock.API.Controller.Tokens; public sealed partial class TokensController @@ -32,6 +34,7 @@ public sealed partial class TokensController [EnableRateLimiting("token-reporting")] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] + [ApiVersion(1)] public async Task ReportTokens( [FromBody] ReportTokensRequest body, [FromServices] ICloudflareTurnstileService turnstileService, diff --git a/API/Controller/Tokens/Tokens.cs b/API/Controller/Tokens/Tokens.cs index dfce87f06..9d845637c 100644 --- a/API/Controller/Tokens/Tokens.cs +++ b/API/Controller/Tokens/Tokens.cs @@ -1,5 +1,5 @@ using System.Net.Mime; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Requests; using OpenShock.API.Models.Response; @@ -20,7 +20,7 @@ public sealed partial class TokensController /// /// All tokens for the current user [HttpGet] - [MapToApiVersion("1")] + [ApiVersion(1)] public IAsyncEnumerable ListTokens([FromServices] IApiTokenService tokenService) { return tokenService.ListTokensV1(ownerId: CurrentUser.Id); @@ -31,7 +31,7 @@ public IAsyncEnumerable ListTokens([FromServices] IApiTokenServic /// /// All tokens for the current user [HttpGet] - [MapToApiVersion("2")] + [ApiVersion(2)] public IAsyncEnumerable ListTokensV2([FromServices] IApiTokenService tokenService) { return tokenService.ListTokensV2(ownerId: CurrentUser.Id); @@ -47,7 +47,7 @@ public IAsyncEnumerable ListTokensV2([FromServices] IApiTokenSe [HttpGet("{tokenId}")] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ApiTokenNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task GetTokenById([FromRoute] Guid tokenId, [FromServices] IApiTokenService tokenService) { var apiToken = await tokenService.GetTokenV1(tokenId, CurrentUser.Id); @@ -66,7 +66,7 @@ public async Task GetTokenById([FromRoute] Guid tokenId, [FromSer [HttpGet("{tokenId}")] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ApiTokenNotFound - [MapToApiVersion("2")] + [ApiVersion(2)] public async Task GetTokenByIdV2([FromRoute] Guid tokenId, [FromServices] IApiTokenService tokenService) { var apiToken = await tokenService.GetTokenV2(tokenId, CurrentUser.Id); @@ -84,7 +84,7 @@ public async Task GetTokenByIdV2([FromRoute] Guid tokenId, [FromS [HttpPost] [Consumes(MediaTypeNames.Application.Json)] [Produces(MediaTypeNames.Application.Json)] - [MapToApiVersion("1")] + [ApiVersion(1)] public Task CreateToken( [FromBody] CreateTokenRequest body, [FromServices] IApiTokenService tokenService) @@ -104,7 +104,7 @@ public Task CreateToken( [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ApiTokenNotFound - [MapToApiVersion("1")] + [ApiVersion(1)] public async Task EditToken([FromRoute] Guid tokenId, [FromBody] EditTokenRequest body, [FromServices] IApiTokenService tokenService) { if (!await tokenService.EditTokenV1(tokenId, body, CurrentUser.Id)) return Problem(ApiTokenError.ApiTokenNotFound); @@ -121,7 +121,7 @@ public async Task EditToken([FromRoute] Guid tokenId, [FromBody] [HttpPost] [Consumes(MediaTypeNames.Application.Json)] [Produces(MediaTypeNames.Application.Json)] - [MapToApiVersion("2")] + [ApiVersion(2)] public Task CreateTokenV2( [FromBody] CreateTokenRequestV2 body, [FromServices] IApiTokenService tokenService) @@ -141,7 +141,7 @@ public Task CreateTokenV2( [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ApiTokenNotFound - [MapToApiVersion("2")] + [ApiVersion(2)] public async Task EditTokenV2([FromRoute] Guid tokenId, [FromBody] EditTokenRequestV2 body, [FromServices] IApiTokenService tokenService) { if (!await tokenService.EditTokenV2(tokenId, body, CurrentUser.Id)) return Problem(ApiTokenError.ApiTokenNotFound); @@ -161,7 +161,7 @@ public async Task EditTokenV2([FromRoute] Guid tokenId, [FromBody [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ApiTokenNotFound - [MapToApiVersion("2")] + [ApiVersion(2)] public async Task SetTokenPaused([FromRoute] Guid tokenId, [FromBody] SetTokenPausedRequest body, [FromServices] IApiTokenService tokenService) { var paused = await tokenService.SetTokenPaused(tokenId, body.Paused, CurrentUser.Id); diff --git a/API/Controller/Tokens/_ApiController.cs b/API/Controller/Tokens/_ApiController.cs index a45545f14..2b7aabe3a 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 b3a3ced8b..33d5c7f42 100644 --- a/API/Controller/Users/GetSelf.cs +++ b/API/Controller/Users/GetSelf.cs @@ -1,4 +1,5 @@ -using System.Net.Mime; +using OpenShock.Common.ApiVersioning; +using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using OpenShock.Common.Extensions; using OpenShock.Common.Models; @@ -12,6 +13,7 @@ public sealed partial class UsersController /// Get the current user's information. /// /// The user's information was successfully retrieved. + [ApiVersion(1)] [HttpGet("self")] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public IActionResult GetSelf() diff --git a/API/Controller/Users/LookupByName.cs b/API/Controller/Users/LookupByName.cs index 8c0251149..c3d3eebd8 100644 --- a/API/Controller/Users/LookupByName.cs +++ b/API/Controller/Users/LookupByName.cs @@ -1,4 +1,5 @@ -using System.Net.Mime; +using OpenShock.Common.ApiVersioning; +using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Services.UserService; using OpenShock.Common.Errors; @@ -11,6 +12,7 @@ namespace OpenShock.API.Controller.Users; public sealed partial class UsersController { + [ApiVersion(1)] [HttpGet("by-name/{username}")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] diff --git a/API/Controller/Version/_ApiController.cs b/API/Controller/Version/_ApiController.cs index da8ec6a40..915d8eaf1 100644 --- a/API/Controller/Version/_ApiController.cs +++ b/API/Controller/Version/_ApiController.cs @@ -1,4 +1,5 @@ -using System.Net.Mime; +using OpenShock.Common.ApiVersioning; +using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using OpenShock.API.OAuth; using OpenShock.API.Options; @@ -19,8 +20,8 @@ namespace OpenShock.API.Controller.Version; /// Version stuff /// [ApiController] -[Tags("Meta")] [Route("/{version:apiVersion}")] +[Tags("Meta")] public sealed partial class VersionController : OpenShockControllerBase { private static string GetBackendVersion() @@ -40,6 +41,7 @@ private static string GetBackendVersion() /// Gets the version of the OpenShock backend. /// /// The version was successfully retrieved. + [ApiVersion(1)] [HttpGet] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task GetBackendInfo( diff --git a/API/Program.cs b/API/Program.cs index c640cf3aa..136e84d09 100644 --- a/API/Program.cs +++ b/API/Program.cs @@ -118,6 +118,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..0d586d640 --- /dev/null +++ b/Common/ApiVersioning/ApiVersionAttribute.cs @@ -0,0 +1,19 @@ +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. +/// +/// An action without it is not versioned, and its route may not contain the placeholder. See . +[AttributeUsage(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..7ef1d5e21 --- /dev/null +++ b/Common/ApiVersioning/ApiVersionRouteConvention.cs @@ -0,0 +1,69 @@ +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 +/// : /{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)?.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 5ddb1b53b..25874cbac 100644 --- a/Common/Common.csproj +++ b/Common/Common.csproj @@ -33,8 +33,6 @@ - - diff --git a/Common/OpenApi/ControllerTagDescriptionTransformer.cs b/Common/OpenApi/ControllerTagDescriptionTransformer.cs deleted file mode 100644 index 961216b0b..000000000 --- a/Common/OpenApi/ControllerTagDescriptionTransformer.cs +++ /dev/null @@ -1,52 +0,0 @@ -using Asp.Versioning.OpenApi.Transformers; -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 Swashbuckle's IncludeXmlComments(..., includeControllerXmlComments: true) used to do. -/// -public sealed class ControllerTagDescriptionTransformer(XmlComments 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 dd8182e88..000000000 --- a/Common/OpenApi/DocumentedResponsesTransformer.cs +++ /dev/null @@ -1,41 +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 Swashbuckle's XML comments filter used to add. -/// -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; - - // The library's XmlCommentsTransformer describes existing responses too, but cannot find methods with a nested-type parameter - 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/DocumentedXmlComments.cs b/Common/OpenApi/DocumentedXmlComments.cs deleted file mode 100644 index 1db71c4bf..000000000 --- a/Common/OpenApi/DocumentedXmlComments.cs +++ /dev/null @@ -1,77 +0,0 @@ -using System.Collections.Concurrent; -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) -{ - private readonly ConcurrentDictionary _nestedTypeMembers = new(); - - 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. For those methods only, falls back to matching by declaring type, name and parameter count - /// (when that is unambiguous). - /// - protected override XElement? GetMember(MemberInfo member) - { - var found = base.GetMember(member); - if (found is not null || member is not MethodInfo method) return found; - - return HasNestedTypeParameter(method) ? _nestedTypeMembers.GetOrAdd(method, FindByName) : null; - } - - private XElement? FindByName(MethodInfo method) - { - if (method.DeclaringType?.FullName is not { } typeName) return null; - - var prefix = $"M:{typeName.Replace('+', '.')}.{method.Name}"; - var parameterCount = method.GetParameters().Length; - - var matches = Xml.Descendants("member") - .Where(m => m.Attribute("name")?.Value is { } name && name.StartsWith(prefix, StringComparison.Ordinal) && IsSignature(name, prefix.Length, parameterCount)) - .Take(2) - .ToArray(); - - return matches.Length == 1 ? matches[0] : null; - } - - private static bool HasNestedTypeParameter(MethodInfo method) => method.GetParameters().Any(p => ContainsNestedType(p.ParameterType)); - - private static bool ContainsNestedType(Type type) - { - if (type.IsNested) return true; - if (type.HasElementType) return ContainsNestedType(type.GetElementType()!); - return type.IsGenericType && type.GetGenericArguments().Any(ContainsNestedType); - } - - /// - /// Whether the member id continues after with exactly parameters - /// (or ends there, for a method without any). - /// - private static bool IsSignature(string id, int nameLength, int parameterCount) - { - if (id.Length == nameLength) return parameterCount == 0; - if (id[nameLength] != '(') return false; - - var count = 1; - var depth = 0; - foreach (var c in id.AsSpan(nameLength + 1)) - { - switch (c) - { - case '{' or '[': depth++; break; - case '}' or ']': depth--; break; - case ',' when depth == 0: count++; break; - } - } - - return count == parameterCount; - } -} diff --git a/Common/OpenApi/OpenApiXmlDocumentation.cs b/Common/OpenApi/OpenApiXmlDocumentation.cs deleted file mode 100644 index f56956e45..000000000 --- a/Common/OpenApi/OpenApiXmlDocumentation.cs +++ /dev/null @@ -1,59 +0,0 @@ -using System.Reflection; -using Asp.Versioning.OpenApi.Transformers; -using Serilog; - -namespace OpenShock.Common.OpenApi; - -/// -/// The XML documentation of the running host and of Common, loaded once per process and shared by every OpenAPI document. -/// Documentation is optional: when it cannot be loaded the documents are served without descriptions. -/// -internal sealed class OpenApiXmlDocumentation -{ - private static readonly Lazy Shared = new(Load); - - public required DocumentedXmlComments Comments { get; init; } - public required XmlCommentsTransformer Transformer { get; init; } - - public static OpenApiXmlDocumentation? Get() => Shared.Value; - - private static OpenApiXmlDocumentation? Load() - { - try - { - // Documentation of whichever host is running (API/Cron/LiveControlGateway), plus the shared Common assembly - var names = new[] { Assembly.GetEntryAssembly()?.GetName().Name, typeof(OpenApiXmlDocumentation).Assembly.GetName().Name } - .OfType() - .Distinct(); - - var paths = new List(); - foreach (var path in names.Select(name => Path.Combine(AppContext.BaseDirectory, name + ".xml"))) - { - if (File.Exists(path)) paths.Add(path); - else Log.Warning("OpenAPI XML documentation file {Path} was not found, its descriptions are left out", path); - } - - if (paths.Count == 0) return null; - - // The library only reads documentation from a file, so the merged copy exists just while it is loaded - var filledPath = XmlCrefText.CreateFilledCopy(paths); - try - { - return new OpenApiXmlDocumentation - { - Comments = new DocumentedXmlComments(filledPath), - Transformer = new XmlCommentsTransformer(filledPath) - }; - } - finally - { - File.Delete(filledPath); - } - } - catch (Exception e) - { - Log.Warning(e, "Failed to load OpenAPI XML documentation, documents are served without descriptions"); - return null; - } - } -} 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/OpenApi/XmlCrefText.cs b/Common/OpenApi/XmlCrefText.cs deleted file mode 100644 index 456800968..000000000 --- a/Common/OpenApi/XmlCrefText.cs +++ /dev/null @@ -1,52 +0,0 @@ -using System.Xml.Linq; - -namespace OpenShock.Common.OpenApi; - -/// -/// 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. -/// -internal 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(IReadOnlyList paths) - { - // Whitespace is significant: it is the space between adjacent tags and the margin the library strips - var xml = XDocument.Load(paths[0], LoadOptions.PreserveWhitespace); - - // 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, LoadOptions.PreserveWhitespace).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(); - try - { - xml.Save(copy, SaveOptions.DisableFormatting); - } - catch - { - File.Delete(copy); - throw; - } - - return copy; - } -} diff --git a/Common/OpenShockMiddlewareHelper.cs b/Common/OpenShockMiddlewareHelper.cs index bc59762ee..0786a8ab6 100644 --- a/Common/OpenShockMiddlewareHelper.cs +++ b/Common/OpenShockMiddlewareHelper.cs @@ -1,6 +1,5 @@ using Microsoft.AspNetCore.Diagnostics.HealthChecks; using Microsoft.AspNetCore.HttpOverrides; -using Microsoft.AspNetCore.OpenApi; using Microsoft.EntityFrameworkCore; using Microsoft.Extensions.Diagnostics.HealthChecks; using OpenShock.Common.HealthChecks; @@ -21,8 +20,6 @@ namespace OpenShock.Common; public static class OpenShockMiddlewareHelper { - private static readonly SemaphoreSlim OpenApiDocumentGate = new(1, 1); - private static readonly ForwardedHeadersOptions ForwardedSettings = new() { ForwardedHeaders = ForwardedHeaders.All, @@ -125,30 +122,12 @@ exception is null return IsAllowed(context.Connection.RemoteIpAddress, internalAllowedIpNetworks); }); - // Asp.Versioning.OpenApi builds the options of each document through one shared factory that keeps its state in a field, - // so two documents first requested at the same time (the Scalar viewer loads both) corrupt each other: one request fails - // with a NullReferenceException and the other gets an unconfigured document, and both results are cached for the process. - // Serializing the document endpoints avoids that; they are rarely hit, so the lost concurrency does not matter. - app.UseWhen(context => context.Request.Path.StartsWithSegments("/openapi"), branch => branch.Use(async (context, next) => - { - await OpenApiDocumentGate.WaitAsync(context.RequestAborted); - try - { - await next(context); - } - finally - { - OpenApiDocumentGate.Release(); - } - })); - - app.MapOpenApi("/openapi/{documentName}.json").WithDocumentPerVersion(); + app.MapOpenApi("/openapi/{documentName}.json"); app.MapScalarApiReference("/scalar/viewer", options => options .WithOpenApiRoutePattern("/openapi/{documentName}.json") - .AddDocument("1", "Version 1") - .AddDocument("2", "Version 2") + .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 6c592d5bc..63883532a 100644 --- a/Common/OpenShockServiceHelper.cs +++ b/Common/OpenShockServiceHelper.cs @@ -1,17 +1,18 @@ using System.Net; using System.Reflection; using System.Security.Claims; -using Asp.Versioning; -using Asp.Versioning.OpenApi.Transformers; using Microsoft.AspNetCore.Authentication; using Microsoft.AspNetCore.DataProtection; using Microsoft.AspNetCore.Authorization; 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.Extensions.Hosting; using Microsoft.OpenApi; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication; using OpenShock.Common.Authentication.AuthenticationHandlers; using OpenShock.Common.Authentication.Services; @@ -43,6 +44,11 @@ namespace OpenShock.Common; public static class OpenShockServiceHelper { + /// + /// Name of the single OpenAPI document, served at /openapi/{name}.json. + /// + public const string OpenApiDocumentName = "openshock"; + /// /// 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. @@ -129,6 +135,73 @@ 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; + }); + + // .NET 10 defaults to OpenAPI 3.1; keep 3.0 so existing clients/tooling see the same dialect as with Swashbuckle. + options.OpenApiVersion = OpenApiSpecVersion.OpenApi3_0; + options.CreateSchemaReferenceId = OpenShockSchemaIds.Create; + + options.AddOperationTransformer(); + options.AddSchemaTransformer(); + options.AddDocumentTransformer(); + options.AddDocumentTransformer(); + } + /// /// Register all OpenShock services for PRODUCTION use /// @@ -181,101 +254,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; - }); - - // .NET 10 defaults to OpenAPI 3.1; keep 3.0 so existing clients/tooling see the same dialect as with Swashbuckle. - options.Document.OpenApiVersion = OpenApiSpecVersion.OpenApi3_0; - options.Document.CreateSchemaReferenceId = OpenShockSchemaIds.Create; - - options.Document.AddOperationTransformer(); - options.Document.AddSchemaTransformer(); - options.Document.AddDocumentTransformer(); - options.Document.AddDocumentTransformer(); - - // Picks up XML doc comments (, , ...), mirroring what Swashbuckle's IncludeXmlComments used to do. - if (OpenApiXmlDocumentation.Get() is { } documentation) - { - options.Document.AddDocumentTransformer(documentation.Transformer); - options.Document.AddDocumentTransformer(new ControllerTagDescriptionTransformer(documentation.Comments)); - options.Document.AddOperationTransformer(new DocumentedResponsesTransformer(documentation.Comments)); - options.Document.AddOperationTransformer(documentation.Transformer); - options.Document.AddSchemaTransformer(documentation.Transformer); - } - }); + // 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 4091f69e4..46482ab68 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; set; } /// - /// 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/Common/Websocket/WebsockBaseController.cs b/Common/Websocket/WebsockBaseController.cs index 63e9b4681..89f94a336 100644 --- a/Common/Websocket/WebsockBaseController.cs +++ b/Common/Websocket/WebsockBaseController.cs @@ -111,7 +111,7 @@ public virtual async ValueTask DisposeAsync() /// [HttpGet] [ApiExplorerSettings(IgnoreApi = true)] - public async Task Get([FromServices] IHostApplicationLifetime lifetime, CancellationToken cancellationToken) + public virtual async Task Get([FromServices] IHostApplicationLifetime lifetime, CancellationToken cancellationToken) { #pragma warning disable IDISP003 _linkedSource = CancellationTokenSource.CreateLinkedTokenSource(lifetime.ApplicationStopping, cancellationToken); 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 f1292b0c5..25c176a29 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 f70f8b941..f9988fcb9 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -47,13 +47,6 @@ true - - $(WarningsNotAsErrors);NU1608 - $(NoWarn);IDE0049 diff --git a/Directory.Packages.props b/Directory.Packages.props index ef43dcdb1..eb9777185 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 9d3a067f9..2d24862ec 100644 --- a/LiveControlGateway/Controllers/HubV1Controller.cs +++ b/LiveControlGateway/Controllers/HubV1Controller.cs @@ -1,4 +1,4 @@ -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.SignalR; @@ -21,11 +21,15 @@ namespace OpenShock.LiveControlGateway.Controllers; /// Communication with the hubs aka ESP-32 microcontrollers /// [ApiController] -[ApiVersion("1")] [Route("/{version:apiVersion}/ws/device")] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.HubToken)] public sealed class HubV1Controller : HubControllerBase { + /// + [ApiVersion(1)] + public override Task Get([FromServices] IHostApplicationLifetime lifetime, CancellationToken cancellationToken) => + base.Get(lifetime, cancellationToken); + private readonly IHubContext _userHubContext; /// diff --git a/LiveControlGateway/Controllers/HubV2Controller.cs b/LiveControlGateway/Controllers/HubV2Controller.cs index a7dc7d4d1..74093a930 100644 --- a/LiveControlGateway/Controllers/HubV2Controller.cs +++ b/LiveControlGateway/Controllers/HubV2Controller.cs @@ -1,5 +1,5 @@ -using System.Diagnostics; -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; +using System.Diagnostics; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.SignalR; @@ -21,11 +21,15 @@ namespace OpenShock.LiveControlGateway.Controllers; /// Communication with the hubs aka ESP-32 microcontrollers /// [ApiController] -[ApiVersion("2")] [Route("/{version:apiVersion}/ws/hub")] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.HubToken)] public sealed class HubV2Controller : HubControllerBase { + /// + [ApiVersion(2)] + public override Task Get([FromServices] IHostApplicationLifetime lifetime, CancellationToken cancellationToken) => + base.Get(lifetime, cancellationToken); + private readonly IHubContext _userHubContext; private readonly Timer _pingTimer; private long _pingTimestamp = Stopwatch.GetTimestamp(); diff --git a/LiveControlGateway/Controllers/InstanceDetailsController.cs b/LiveControlGateway/Controllers/InstanceDetailsController.cs index 360d6ac5e..70eb0afd7 100644 --- a/LiveControlGateway/Controllers/InstanceDetailsController.cs +++ b/LiveControlGateway/Controllers/InstanceDetailsController.cs @@ -1,4 +1,4 @@ -using Asp.Versioning; +using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using OpenShock.Common; using OpenShock.Common.Utils; @@ -15,7 +15,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(); @@ -28,7 +27,7 @@ public sealed class InstanceDetailsController : OpenShockControllerBase /// Instance details was successfully retrieved. [HttpGet] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] - [MapToApiVersion("1")] + [ApiVersion(1)] public InstanceDetailsResponse GetNodeInfo([FromServices] LcgOptions options) { return new InstanceDetailsResponse diff --git a/LiveControlGateway/Controllers/LiveControlController.cs b/LiveControlGateway/Controllers/LiveControlController.cs index 3c260de47..53ea72dc0 100644 --- a/LiveControlGateway/Controllers/LiveControlController.cs +++ b/LiveControlGateway/Controllers/LiveControlController.cs @@ -1,4 +1,5 @@ -using System.Diagnostics; +using OpenShock.Common.ApiVersioning; +using System.Diagnostics; using System.Net.WebSockets; using System.Text.Json; using Microsoft.AspNetCore.Authorization; @@ -43,6 +44,11 @@ namespace OpenShock.LiveControlGateway.Controllers; public sealed class LiveControlController : WebsocketBaseController>, IActionFilter { + /// + [ApiVersion(1)] + public override Task Get([FromServices] IHostApplicationLifetime lifetime, CancellationToken cancellationToken) => + base.Get(lifetime, cancellationToken); + private readonly HubLifetimeManager _hubLifetimeManager; private readonly IDbContextFactory _dbContextFactory; private readonly IUserReferenceService _userReferenceService; diff --git a/LiveControlGateway/LiveControlGateway.csproj b/LiveControlGateway/LiveControlGateway.csproj index 135361501..0f58a83e7 100644 --- a/LiveControlGateway/LiveControlGateway.csproj +++ b/LiveControlGateway/LiveControlGateway.csproj @@ -3,6 +3,11 @@ + + + + + diff --git a/LiveControlGateway/Program.cs b/LiveControlGateway/Program.cs index fd5aa6b4c..cda91c259 100644 --- a/LiveControlGateway/Program.cs +++ b/LiveControlGateway/Program.cs @@ -30,6 +30,9 @@ .AddOpenShockServices(configureMetrics: metricsBuilder => { metricsBuilder.AddMeter("OpenShock.Gateway"); }) .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(); From 342b164a3a86e43dc782e58f7c13fb5a5987ba64 Mon Sep 17 00:00:00 2001 From: HeavenVR Date: Sun, 15 Nov 2026 12:07:35 +0100 Subject: [PATCH 3/8] fix using statement order --- .../Account/Authenticated/ChangeEmail.cs | 5 ++--- .../Account/Authenticated/ChangePassword.cs | 6 ++---- .../Account/Authenticated/ChangeUsername.cs | 3 +-- .../Account/Authenticated/Deactivate.cs | 7 +++---- .../Account/Authenticated/GetAuditLog.cs | 2 +- .../Authenticated/OAuthConnectionRemove.cs | 1 - .../Authenticated/OAuthConnectionsList.cs | 1 - API/Controller/Account/CheckUsername.cs | 4 ++-- API/Controller/Account/Login.cs | 2 +- API/Controller/Account/LoginV2.cs | 12 ++++++------ API/Controller/Account/Logout.cs | 4 ++-- .../Account/PasswordResetCheckValid.cs | 6 +++--- API/Controller/Account/PasswordResetComplete.cs | 6 +++--- API/Controller/Account/PasswordResetInitiate.cs | 2 +- .../Account/PasswordResetInitiateV2.cs | 2 +- API/Controller/Account/Signup.cs | 2 +- API/Controller/Account/SignupV2.cs | 10 +++++----- API/Controller/Account/VerifyEmail.cs | 2 +- API/Controller/Account/_ApiController.cs | 2 +- API/Controller/Admin/Configuration.cs | 7 +++---- API/Controller/Admin/DeactivateUser.cs | 3 +-- API/Controller/Admin/DeleteUser.cs | 3 +-- API/Controller/Admin/EmailOutboxBulk.cs | 2 +- API/Controller/Admin/EmailOutboxCancel.cs | 2 +- API/Controller/Admin/EmailOutboxList.cs | 7 ++++--- API/Controller/Admin/EmailOutboxRequeue.cs | 2 +- API/Controller/Admin/EmailOutboxStats.cs | 4 ++-- API/Controller/Admin/EmailOutboxTestSend.cs | 2 +- .../Admin/EmailProviderBlacklistAdd.cs | 2 +- API/Controller/Admin/GetAuditLog.cs | 2 +- API/Controller/Admin/GetOnlineDevices.cs | 7 +++---- API/Controller/Admin/GetUsers.cs | 11 +++++------ API/Controller/Admin/PatchUser.cs | 1 - API/Controller/Admin/ReactivateUser.cs | 3 +-- API/Controller/Admin/UserNameBlacklistAdd.cs | 2 +- API/Controller/Admin/WebhookAdd.cs | 3 +-- API/Controller/Admin/WebhookList.cs | 3 +-- API/Controller/Admin/WebhookRemove.cs | 3 +-- API/Controller/Device/AssignLCG.cs | 8 ++++---- API/Controller/Device/AssignLCGV2.cs | 6 +++--- API/Controller/Device/GetSelf.cs | 2 +- API/Controller/Device/Pair.cs | 10 +++++----- API/Controller/Devices/DeviceOtaController.cs | 3 +-- API/Controller/Devices/DevicesController.cs | 6 ++---- API/Controller/Devices/GetShockers.cs | 6 +++--- API/Controller/OAuth/Authorize.cs | 2 +- API/Controller/OAuth/HandOff.cs | 8 ++++---- API/Controller/OAuth/SignupFinalize.cs | 4 ++-- API/Controller/OAuth/SignupGetData.cs | 4 ++-- API/Controller/Public/GetStats.cs | 4 ++-- API/Controller/Public/PublicShareController.cs | 4 ++-- API/Controller/Sessions/DeleteSessions.cs | 3 +-- API/Controller/Sessions/ListSessions.cs | 1 - API/Controller/Sessions/SessionSelf.cs | 3 +-- API/Controller/Shares/DeleteShareCode.cs | 3 +-- API/Controller/Shares/LinkShareCode.cs | 3 +-- API/Controller/Shares/Links/AddShocker.cs | 8 ++++---- API/Controller/Shares/Links/CreatePublicShare.cs | 4 ++-- API/Controller/Shares/Links/DeletePublicShare.cs | 8 ++++---- API/Controller/Shares/Links/EditShocker.cs | 4 ++-- API/Controller/Shares/Links/List.cs | 4 ++-- API/Controller/Shares/Links/PauseShocker.cs | 6 +++--- API/Controller/Shares/Links/RemoveShocker.cs | 8 ++++---- .../Shares/UserShares/CreateShareInvite.cs | 2 +- API/Controller/Shares/UserShares/GetShares.cs | 4 ++-- API/Controller/Shares/UserShares/Invites.cs | 2 +- .../Shares/UserShares/PauseShockerShares.cs | 2 +- .../Shares/UserShares/RemoveShockerShares.cs | 2 +- .../Shares/UserShares/UpdateShockerShares.cs | 2 +- API/Controller/Shockers/EditShocker.cs | 2 +- API/Controller/Shockers/GetShockerById.cs | 2 +- API/Controller/Shockers/GetShockerLogs.cs | 2 +- API/Controller/Shockers/ListSharedShockers.cs | 2 +- API/Controller/Shockers/ListShockers.cs | 2 +- API/Controller/Shockers/PauseShocker.cs | 2 +- API/Controller/Shockers/RegisterShocker.cs | 3 +-- API/Controller/Shockers/RemoveShocker.cs | 2 +- API/Controller/Shockers/ShockerShares.cs | 10 +++++----- API/Controller/Tokens/DeleteToken.cs | 4 ++-- API/Controller/Tokens/GetTokenSelf.cs | 2 +- API/Controller/Tokens/ReportTokens.cs | 16 +++++++--------- API/Controller/Tokens/Tokens.cs | 2 +- API/Controller/Users/GetSelf.cs | 4 ++-- API/Controller/Users/LookupByName.cs | 4 ++-- API/Controller/Version/_ApiController.cs | 8 ++++---- Common/OpenShockServiceHelper.cs | 13 +++++++------ Common/Websocket/WebsockBaseController.cs | 4 +--- .../Controllers/HubV1Controller.cs | 4 ++-- .../Controllers/HubV2Controller.cs | 4 ++-- .../Controllers/InstanceDetailsController.cs | 6 +++--- .../Controllers/LiveControlController.cs | 8 +++----- 91 files changed, 180 insertions(+), 210 deletions(-) diff --git a/API/Controller/Account/Authenticated/ChangeEmail.cs b/API/Controller/Account/Authenticated/ChangeEmail.cs index 0ff3fbb2b..0e09a1e4a 100644 --- a/API/Controller/Account/Authenticated/ChangeEmail.cs +++ b/API/Controller/Account/Authenticated/ChangeEmail.cs @@ -3,15 +3,14 @@ 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.Problems; using OpenShock.Common.Utils; using Results = OpenShock.Common.Results; -using OpenShock.Common.ApiVersioning; - -using OpenShock.Internal.Common.Utils; using OpenShock.Internal.Common.Problems; +using OpenShock.Internal.Common.Utils; namespace OpenShock.API.Controller.Account.Authenticated; diff --git a/API/Controller/Account/Authenticated/ChangePassword.cs b/API/Controller/Account/Authenticated/ChangePassword.cs index c295d8b0c..2699edc84 100644 --- a/API/Controller/Account/Authenticated/ChangePassword.cs +++ b/API/Controller/Account/Authenticated/ChangePassword.cs @@ -3,16 +3,14 @@ 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.Problems; using OpenShock.Common.Utils; using Results = OpenShock.Common.Results; -using OpenShock.Internal.Common.Utils; - using OpenShock.Internal.Common.Problems; - -using OpenShock.Common.ApiVersioning; +using OpenShock.Internal.Common.Utils; namespace OpenShock.API.Controller.Account.Authenticated; diff --git a/API/Controller/Account/Authenticated/ChangeUsername.cs b/API/Controller/Account/Authenticated/ChangeUsername.cs index 74401402c..aa3551636 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.Problems; @@ -11,8 +12,6 @@ using OpenShock.Internal.Common.Problems; -using OpenShock.Common.ApiVersioning; - namespace OpenShock.API.Controller.Account.Authenticated; public sealed partial class AuthenticatedAccountController diff --git a/API/Controller/Account/Authenticated/Deactivate.cs b/API/Controller/Account/Authenticated/Deactivate.cs index a73356a88..bdb7d5849 100644 --- a/API/Controller/Account/Authenticated/Deactivate.cs +++ b/API/Controller/Account/Authenticated/Deactivate.cs @@ -1,7 +1,8 @@ -using Microsoft.AspNetCore.Mvc; -using System.Diagnostics; +using System.Diagnostics; using System.Net.Mime; +using Microsoft.AspNetCore.Mvc; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Problems; using AccountSvc = OpenShock.API.Services.Account; @@ -9,8 +10,6 @@ using OpenShock.Internal.Common.Problems; -using OpenShock.Common.ApiVersioning; - namespace OpenShock.API.Controller.Account.Authenticated; public sealed partial class AuthenticatedAccountController diff --git a/API/Controller/Account/Authenticated/GetAuditLog.cs b/API/Controller/Account/Authenticated/GetAuditLog.cs index cbddd2bcc..58fd17a43 100644 --- a/API/Controller/Account/Authenticated/GetAuditLog.cs +++ b/API/Controller/Account/Authenticated/GetAuditLog.cs @@ -1,10 +1,10 @@ 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.Pagination; -using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Account.Authenticated; diff --git a/API/Controller/Account/Authenticated/OAuthConnectionRemove.cs b/API/Controller/Account/Authenticated/OAuthConnectionRemove.cs index 0bfd136a6..3d529595b 100644 --- a/API/Controller/Account/Authenticated/OAuthConnectionRemove.cs +++ b/API/Controller/Account/Authenticated/OAuthConnectionRemove.cs @@ -1,6 +1,5 @@ using Microsoft.AspNetCore.Mvc; using OpenShock.API.Services.OAuthConnection; - using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Account.Authenticated; diff --git a/API/Controller/Account/Authenticated/OAuthConnectionsList.cs b/API/Controller/Account/Authenticated/OAuthConnectionsList.cs index 9c2b082ef..c4ec0347e 100644 --- a/API/Controller/Account/Authenticated/OAuthConnectionsList.cs +++ b/API/Controller/Account/Authenticated/OAuthConnectionsList.cs @@ -3,7 +3,6 @@ using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; using OpenShock.API.Services.OAuthConnection; - using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Account.Authenticated; diff --git a/API/Controller/Account/CheckUsername.cs b/API/Controller/Account/CheckUsername.cs index a6ce08193..a0702cef4 100644 --- a/API/Controller/Account/CheckUsername.cs +++ b/API/Controller/Account/CheckUsername.cs @@ -1,10 +1,10 @@ -using OpenShock.Common.ApiVersioning; -using System.Diagnostics; +using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Net.Mime; 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; diff --git a/API/Controller/Account/Login.cs b/API/Controller/Account/Login.cs index bf15dc325..90dc1bfb0 100644 --- a/API/Controller/Account/Login.cs +++ b/API/Controller/Account/Login.cs @@ -1,5 +1,5 @@ -using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Internal.Common.Problems; diff --git a/API/Controller/Account/LoginV2.cs b/API/Controller/Account/LoginV2.cs index 11d11375d..3ce2aedd6 100644 --- a/API/Controller/Account/LoginV2.cs +++ b/API/Controller/Account/LoginV2.cs @@ -1,15 +1,15 @@ -using Microsoft.AspNetCore.Mvc; -using OpenShock.API.Models.Requests; -using System.Diagnostics; +using System.Diagnostics; using System.Net.Mime; -using OpenShock.Common.ApiVersioning; +using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; +using OpenShock.API.Models.Requests; +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.Problems; -using OpenShock.API.Models.Response; -using OpenShock.API.Services.Turnstile; using Results = OpenShock.Common.Results; using OpenShock.Internal.Common.Problems; diff --git a/API/Controller/Account/Logout.cs b/API/Controller/Account/Logout.cs index c4abad943..d44ccc50f 100644 --- a/API/Controller/Account/Logout.cs +++ b/API/Controller/Account/Logout.cs @@ -1,5 +1,5 @@ -using OpenShock.Common.ApiVersioning; -using Microsoft.AspNetCore.Mvc; +using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Extensions; using OpenShock.Common.Services.Session; diff --git a/API/Controller/Account/PasswordResetCheckValid.cs b/API/Controller/Account/PasswordResetCheckValid.cs index f33fc5369..40f702811 100644 --- a/API/Controller/Account/PasswordResetCheckValid.cs +++ b/API/Controller/Account/PasswordResetCheckValid.cs @@ -1,13 +1,13 @@ using System; using System.Diagnostics; -using Microsoft.AspNetCore.Mvc; using System.Net.Mime; -using OpenShock.Common.ApiVersioning; +using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; -using OpenShock.Common.Problems; using OpenShock.Common.Models; +using OpenShock.Common.Problems; using Results = OpenShock.Common.Results; using OpenShock.Internal.Common.Problems; diff --git a/API/Controller/Account/PasswordResetComplete.cs b/API/Controller/Account/PasswordResetComplete.cs index 866328f36..549fc7699 100644 --- a/API/Controller/Account/PasswordResetComplete.cs +++ b/API/Controller/Account/PasswordResetComplete.cs @@ -1,13 +1,13 @@ using System; using System.Diagnostics; -using Microsoft.AspNetCore.Mvc; using System.Net.Mime; -using OpenShock.Common.ApiVersioning; +using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; -using OpenShock.Common.Problems; using OpenShock.Common.Models; +using OpenShock.Common.Problems; using Results = OpenShock.Common.Results; using OpenShock.Internal.Common.Problems; diff --git a/API/Controller/Account/PasswordResetInitiate.cs b/API/Controller/Account/PasswordResetInitiate.cs index 5cbdd2e6f..4e79a58df 100644 --- a/API/Controller/Account/PasswordResetInitiate.cs +++ b/API/Controller/Account/PasswordResetInitiate.cs @@ -1,5 +1,5 @@ -using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; namespace OpenShock.API.Controller.Account; diff --git a/API/Controller/Account/PasswordResetInitiateV2.cs b/API/Controller/Account/PasswordResetInitiateV2.cs index 00d08e34d..e950b26a4 100644 --- a/API/Controller/Account/PasswordResetInitiateV2.cs +++ b/API/Controller/Account/PasswordResetInitiateV2.cs @@ -1,9 +1,9 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; -using OpenShock.Common.ApiVersioning; 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.Problems; diff --git a/API/Controller/Account/Signup.cs b/API/Controller/Account/Signup.cs index 02213fd38..d0caec0d2 100644 --- a/API/Controller/Account/Signup.cs +++ b/API/Controller/Account/Signup.cs @@ -1,5 +1,5 @@ -using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Internal.Common.Problems; diff --git a/API/Controller/Account/SignupV2.cs b/API/Controller/Account/SignupV2.cs index 0122ace21..423eaa6e1 100644 --- a/API/Controller/Account/SignupV2.cs +++ b/API/Controller/Account/SignupV2.cs @@ -1,11 +1,11 @@ -using Microsoft.AspNetCore.Mvc; -using OpenShock.API.Models.Requests; -using OpenShock.API.Services.Account; -using System.Diagnostics; +using System.Diagnostics; using System.Net.Mime; -using OpenShock.Common.ApiVersioning; +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.Errors; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Options; diff --git a/API/Controller/Account/VerifyEmail.cs b/API/Controller/Account/VerifyEmail.cs index 6ea882e61..6cd670781 100644 --- a/API/Controller/Account/VerifyEmail.cs +++ b/API/Controller/Account/VerifyEmail.cs @@ -2,8 +2,8 @@ using System.Diagnostics; using System.Net.Mime; using Microsoft.AspNetCore.Mvc; -using OpenShock.Common.ApiVersioning; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Problems; using Results = OpenShock.Common.Results; diff --git a/API/Controller/Account/_ApiController.cs b/API/Controller/Account/_ApiController.cs index 01d916234..ab944076b 100644 --- a/API/Controller/Account/_ApiController.cs +++ b/API/Controller/Account/_ApiController.cs @@ -1,6 +1,6 @@ using Microsoft.AspNetCore.Mvc; -using OpenShock.Common; using OpenShock.API.Services.Account; +using OpenShock.Common; namespace OpenShock.API.Controller.Account; diff --git a/API/Controller/Admin/Configuration.cs b/API/Controller/Admin/Configuration.cs index 3baa0e517..ab2ac276e 100644 --- a/API/Controller/Admin/Configuration.cs +++ b/API/Controller/Admin/Configuration.cs @@ -1,16 +1,15 @@ -using Microsoft.AspNetCore.Mvc; +using System.Net.Mime; +using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Controller.Admin.DTOs; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Problems; using OpenShock.Common.Services.Configuration; -using System.Net.Mime; using Results = OpenShock.Common.Results; using OpenShock.Internal.Common.Problems; -using OpenShock.Common.ApiVersioning; - namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController diff --git a/API/Controller/Admin/DeactivateUser.cs b/API/Controller/Admin/DeactivateUser.cs index a37cdbf4c..c7c316c3e 100644 --- a/API/Controller/Admin/DeactivateUser.cs +++ b/API/Controller/Admin/DeactivateUser.cs @@ -2,13 +2,12 @@ using System.Diagnostics; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Constants; using OpenShock.Common.Errors; using AccountSvc = OpenShock.API.Services.Account; using Results = OpenShock.Common.Results; -using OpenShock.Common.ApiVersioning; - namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController diff --git a/API/Controller/Admin/DeleteUser.cs b/API/Controller/Admin/DeleteUser.cs index 0dfad7c52..38139c780 100644 --- a/API/Controller/Admin/DeleteUser.cs +++ b/API/Controller/Admin/DeleteUser.cs @@ -2,13 +2,12 @@ using System.Diagnostics; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Constants; using OpenShock.Common.Errors; using AccountSvc = OpenShock.API.Services.Account; using Results = OpenShock.Common.Results; -using OpenShock.Common.ApiVersioning; - namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController diff --git a/API/Controller/Admin/EmailOutboxBulk.cs b/API/Controller/Admin/EmailOutboxBulk.cs index ae1be2b9d..a8ccd1e82 100644 --- a/API/Controller/Admin/EmailOutboxBulk.cs +++ b/API/Controller/Admin/EmailOutboxBulk.cs @@ -2,9 +2,9 @@ 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; -using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; diff --git a/API/Controller/Admin/EmailOutboxCancel.cs b/API/Controller/Admin/EmailOutboxCancel.cs index 49c5920dd..dd2ec6314 100644 --- a/API/Controller/Admin/EmailOutboxCancel.cs +++ b/API/Controller/Admin/EmailOutboxCancel.cs @@ -1,7 +1,7 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; -using OpenShock.Common.OpenShockDb; using OpenShock.Common.ApiVersioning; +using OpenShock.Common.OpenShockDb; namespace OpenShock.API.Controller.Admin; diff --git a/API/Controller/Admin/EmailOutboxList.cs b/API/Controller/Admin/EmailOutboxList.cs index 01204ab10..7c330ccd5 100644 --- a/API/Controller/Admin/EmailOutboxList.cs +++ b/API/Controller/Admin/EmailOutboxList.cs @@ -1,15 +1,16 @@ +using System.ComponentModel.DataAnnotations; +using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Controller.Admin.DTOs; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Extensions; using OpenShock.Common.Models; using OpenShock.Common.OpenShockDb; + using OpenShock.Internal.DynamicLinq.Extensions; using OpenShock.Internal.DynamicLinq.Query; -using System.ComponentModel.DataAnnotations; -using System.Net.Mime; -using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; diff --git a/API/Controller/Admin/EmailOutboxRequeue.cs b/API/Controller/Admin/EmailOutboxRequeue.cs index f4da2f233..72aa223de 100644 --- a/API/Controller/Admin/EmailOutboxRequeue.cs +++ b/API/Controller/Admin/EmailOutboxRequeue.cs @@ -1,8 +1,8 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Services.RedisPubSub; -using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; diff --git a/API/Controller/Admin/EmailOutboxStats.cs b/API/Controller/Admin/EmailOutboxStats.cs index 5c2440dc8..f9363d292 100644 --- a/API/Controller/Admin/EmailOutboxStats.cs +++ b/API/Controller/Admin/EmailOutboxStats.cs @@ -1,9 +1,9 @@ +using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Controller.Admin.DTOs; -using OpenShock.Common.OpenShockDb; -using System.Net.Mime; using OpenShock.Common.ApiVersioning; +using OpenShock.Common.OpenShockDb; namespace OpenShock.API.Controller.Admin; diff --git a/API/Controller/Admin/EmailOutboxTestSend.cs b/API/Controller/Admin/EmailOutboxTestSend.cs index f487d2dbd..2bda94bff 100644 --- a/API/Controller/Admin/EmailOutboxTestSend.cs +++ b/API/Controller/Admin/EmailOutboxTestSend.cs @@ -1,9 +1,9 @@ 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; -using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; diff --git a/API/Controller/Admin/EmailProviderBlacklistAdd.cs b/API/Controller/Admin/EmailProviderBlacklistAdd.cs index d2cdec157..ae0a2c969 100644 --- a/API/Controller/Admin/EmailProviderBlacklistAdd.cs +++ b/API/Controller/Admin/EmailProviderBlacklistAdd.cs @@ -2,8 +2,8 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Controller.Admin.DTOs; -using OpenShock.Common.OpenShockDb; using OpenShock.Common.ApiVersioning; +using OpenShock.Common.OpenShockDb; namespace OpenShock.API.Controller.Admin; diff --git a/API/Controller/Admin/GetAuditLog.cs b/API/Controller/Admin/GetAuditLog.cs index b352aa9a3..47db9682c 100644 --- a/API/Controller/Admin/GetAuditLog.cs +++ b/API/Controller/Admin/GetAuditLog.cs @@ -2,9 +2,9 @@ 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; -using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; diff --git a/API/Controller/Admin/GetOnlineDevices.cs b/API/Controller/Admin/GetOnlineDevices.cs index 850f546f9..f33fc86cf 100644 --- a/API/Controller/Admin/GetOnlineDevices.cs +++ b/API/Controller/Admin/GetOnlineDevices.cs @@ -1,13 +1,12 @@ using System.Net.Mime; +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; using OpenShock.Common.Redis; -using System.Text.Json.Serialization; -using OpenShock.Common.JsonSerialization; - -using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; diff --git a/API/Controller/Admin/GetUsers.cs b/API/Controller/Admin/GetUsers.cs index 98e147c47..d7216df94 100644 --- a/API/Controller/Admin/GetUsers.cs +++ b/API/Controller/Admin/GetUsers.cs @@ -1,17 +1,16 @@ -using Microsoft.AspNetCore.Mvc; +using System.ComponentModel.DataAnnotations; +using System.Net.Mime; +using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Extensions; using OpenShock.Common.Models; using OpenShock.Common.OpenShockDb; -using OpenShock.Internal.DynamicLinq.Query; -using System.ComponentModel.DataAnnotations; -using System.Net.Mime; using Z.EntityFramework.Plus; using OpenShock.Internal.DynamicLinq.Extensions; - -using OpenShock.Common.ApiVersioning; +using OpenShock.Internal.DynamicLinq.Query; namespace OpenShock.API.Controller.Admin; diff --git a/API/Controller/Admin/PatchUser.cs b/API/Controller/Admin/PatchUser.cs index fadcc1bbe..6046e1e0d 100644 --- a/API/Controller/Admin/PatchUser.cs +++ b/API/Controller/Admin/PatchUser.cs @@ -2,7 +2,6 @@ using Microsoft.AspNetCore.Mvc; using OpenShock.API.Controller.Admin.DTOs; using OpenShock.API.Services.Account; - using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Admin; diff --git a/API/Controller/Admin/ReactivateUser.cs b/API/Controller/Admin/ReactivateUser.cs index 74c16a62d..e5b42e5a8 100644 --- a/API/Controller/Admin/ReactivateUser.cs +++ b/API/Controller/Admin/ReactivateUser.cs @@ -2,13 +2,12 @@ using System.Diagnostics; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Services.Account; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Constants; using OpenShock.Common.Errors; using AccountSvc = OpenShock.API.Services.Account; using Results = OpenShock.Common.Results; -using OpenShock.Common.ApiVersioning; - namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController diff --git a/API/Controller/Admin/UserNameBlacklistAdd.cs b/API/Controller/Admin/UserNameBlacklistAdd.cs index 257803d5d..776c79048 100644 --- a/API/Controller/Admin/UserNameBlacklistAdd.cs +++ b/API/Controller/Admin/UserNameBlacklistAdd.cs @@ -1,8 +1,8 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Controller.Admin.DTOs; -using OpenShock.Common.OpenShockDb; using OpenShock.Common.ApiVersioning; +using OpenShock.Common.OpenShockDb; namespace OpenShock.API.Controller.Admin; diff --git a/API/Controller/Admin/WebhookAdd.cs b/API/Controller/Admin/WebhookAdd.cs index 9b8c10b65..c5cb570ac 100644 --- a/API/Controller/Admin/WebhookAdd.cs +++ b/API/Controller/Admin/WebhookAdd.cs @@ -1,13 +1,12 @@ 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; using OpenShock.Common.Services.Webhook; -using OpenShock.Common.ApiVersioning; - namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController diff --git a/API/Controller/Admin/WebhookList.cs b/API/Controller/Admin/WebhookList.cs index b0286b3a9..854ec0ba5 100644 --- a/API/Controller/Admin/WebhookList.cs +++ b/API/Controller/Admin/WebhookList.cs @@ -1,9 +1,8 @@ using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Models; using OpenShock.Common.Services.Webhook; -using OpenShock.Common.ApiVersioning; - namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController diff --git a/API/Controller/Admin/WebhookRemove.cs b/API/Controller/Admin/WebhookRemove.cs index ab41be2b5..920d65d64 100644 --- a/API/Controller/Admin/WebhookRemove.cs +++ b/API/Controller/Admin/WebhookRemove.cs @@ -1,9 +1,8 @@ using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Services.Webhook; -using OpenShock.Common.ApiVersioning; - namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController diff --git a/API/Controller/Device/AssignLCG.cs b/API/Controller/Device/AssignLCG.cs index 046d5ba92..d0010fa7c 100644 --- a/API/Controller/Device/AssignLCG.cs +++ b/API/Controller/Device/AssignLCG.cs @@ -1,12 +1,12 @@ -using Microsoft.AspNetCore.Mvc; +using System.Net.Mime; +using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Response; -using System.Net.Mime; -using OpenShock.Common.ApiVersioning; using OpenShock.API.Services.LCGNodeProvisioner; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; +using OpenShock.Common.Models; using OpenShock.Common.Problems; using OpenShock.Common.Utils; -using OpenShock.Common.Models; using OpenShock.Internal.Common.Problems; diff --git a/API/Controller/Device/AssignLCGV2.cs b/API/Controller/Device/AssignLCGV2.cs index f5a0c8914..f5df88296 100644 --- a/API/Controller/Device/AssignLCGV2.cs +++ b/API/Controller/Device/AssignLCGV2.cs @@ -1,8 +1,8 @@ -using Microsoft.AspNetCore.Mvc; +using System.Net.Mime; +using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Response; -using System.Net.Mime; -using OpenShock.Common.ApiVersioning; using OpenShock.API.Services.LCGNodeProvisioner; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Problems; using OpenShock.Common.Utils; diff --git a/API/Controller/Device/GetSelf.cs b/API/Controller/Device/GetSelf.cs index 6c27c7162..66f994d41 100644 --- a/API/Controller/Device/GetSelf.cs +++ b/API/Controller/Device/GetSelf.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using OpenShock.Common.ApiVersioning; 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; diff --git a/API/Controller/Device/Pair.cs b/API/Controller/Device/Pair.cs index c1bae357e..e98b5b629 100644 --- a/API/Controller/Device/Pair.cs +++ b/API/Controller/Device/Pair.cs @@ -1,13 +1,13 @@ -using Microsoft.AspNetCore.Authorization; +using System.Net.Mime; +using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; +using Microsoft.AspNetCore.RateLimiting; using Microsoft.EntityFrameworkCore; -using OpenShock.Common.Redis; -using System.Net.Mime; using OpenShock.Common.ApiVersioning; -using Microsoft.AspNetCore.RateLimiting; using OpenShock.Common.Errors; -using OpenShock.Common.Problems; using OpenShock.Common.Models; +using OpenShock.Common.Problems; +using OpenShock.Common.Redis; using OpenShock.Internal.Common.Problems; diff --git a/API/Controller/Devices/DeviceOtaController.cs b/API/Controller/Devices/DeviceOtaController.cs index 03e831c6b..1f292b328 100644 --- a/API/Controller/Devices/DeviceOtaController.cs +++ b/API/Controller/Devices/DeviceOtaController.cs @@ -2,6 +2,7 @@ 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; @@ -13,8 +14,6 @@ using OpenShock.Internal.Common.Problems; -using OpenShock.Common.ApiVersioning; - namespace OpenShock.API.Controller.Devices; [ApiController] diff --git a/API/Controller/Devices/DevicesController.cs b/API/Controller/Devices/DevicesController.cs index af82501d8..48d3d7e62 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 OpenShock.Common.ApiVersioning; 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.Constants; using OpenShock.Common.Errors; @@ -18,11 +18,9 @@ using OpenShock.Common.Utils; using Redis.OM; -using OpenShock.Internal.Common.Utils; - using OpenShock.Internal.Common.Constants; - using OpenShock.Internal.Common.Problems; +using OpenShock.Internal.Common.Utils; namespace OpenShock.API.Controller.Devices; diff --git a/API/Controller/Devices/GetShockers.cs b/API/Controller/Devices/GetShockers.cs index f194b22b7..63d1e99bf 100644 --- a/API/Controller/Devices/GetShockers.cs +++ b/API/Controller/Devices/GetShockers.cs @@ -1,11 +1,11 @@ -using Microsoft.AspNetCore.Mvc; +using System.Net.Mime; +using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; -using System.Net.Mime; using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; -using OpenShock.Common.Problems; using OpenShock.Common.Models; +using OpenShock.Common.Problems; using OpenShock.Internal.Common.Problems; diff --git a/API/Controller/OAuth/Authorize.cs b/API/Controller/OAuth/Authorize.cs index b8f4905a0..90c48545b 100644 --- a/API/Controller/OAuth/Authorize.cs +++ b/API/Controller/OAuth/Authorize.cs @@ -1,8 +1,8 @@ -using OpenShock.Common.ApiVersioning; using System.ComponentModel.DataAnnotations; 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; diff --git a/API/Controller/OAuth/HandOff.cs b/API/Controller/OAuth/HandOff.cs index c4ba1958f..9592e8d9c 100644 --- a/API/Controller/OAuth/HandOff.cs +++ b/API/Controller/OAuth/HandOff.cs @@ -1,12 +1,12 @@ -using OpenShock.Common.ApiVersioning; -using System.Security.Claims; +using System.Security.Claims; using Microsoft.AspNetCore.Authentication; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; -using OpenShock.API.Services.OAuthConnection; -using OpenShock.Common.Options; using OpenShock.API.OAuth; +using OpenShock.API.Services.OAuthConnection; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Extensions; +using OpenShock.Common.Options; namespace OpenShock.API.Controller.OAuth; diff --git a/API/Controller/OAuth/SignupFinalize.cs b/API/Controller/OAuth/SignupFinalize.cs index cf0de9e7b..971c42abe 100644 --- a/API/Controller/OAuth/SignupFinalize.cs +++ b/API/Controller/OAuth/SignupFinalize.cs @@ -1,4 +1,4 @@ -using OpenShock.Common.ApiVersioning; +using System.Security.Claims; using Microsoft.AspNetCore.Authentication; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; @@ -6,12 +6,12 @@ using OpenShock.API.Models.Response; using OpenShock.API.OAuth; using OpenShock.API.Services.OAuthConnection; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Extensions; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Options; using OpenShock.Common.Results; -using System.Security.Claims; namespace OpenShock.API.Controller.OAuth; diff --git a/API/Controller/OAuth/SignupGetData.cs b/API/Controller/OAuth/SignupGetData.cs index f58a8b64d..ffa25e407 100644 --- a/API/Controller/OAuth/SignupGetData.cs +++ b/API/Controller/OAuth/SignupGetData.cs @@ -1,10 +1,10 @@ -using OpenShock.Common.ApiVersioning; +using System.Security.Claims; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; using OpenShock.API.Models.Response; using OpenShock.API.OAuth; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Extensions; -using System.Security.Claims; namespace OpenShock.API.Controller.OAuth; diff --git a/API/Controller/Public/GetStats.cs b/API/Controller/Public/GetStats.cs index 314983f5f..0d7cfada8 100644 --- a/API/Controller/Public/GetStats.cs +++ b/API/Controller/Public/GetStats.cs @@ -1,7 +1,7 @@ -using OpenShock.Common.ApiVersioning; -using System.Net.Mime; +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; diff --git a/API/Controller/Public/PublicShareController.cs b/API/Controller/Public/PublicShareController.cs index 6ac4dbe3d..584a48c50 100644 --- a/API/Controller/Public/PublicShareController.cs +++ b/API/Controller/Public/PublicShareController.cs @@ -1,9 +1,9 @@ -using OpenShock.Common.ApiVersioning; -using System.Net.Mime; +using System.Net.Mime; using Microsoft.AspNetCore.Mvc; 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; diff --git a/API/Controller/Sessions/DeleteSessions.cs b/API/Controller/Sessions/DeleteSessions.cs index 82bd068ac..8551ea392 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; @@ -7,8 +8,6 @@ using OpenShock.Internal.Common.Problems; -using OpenShock.Common.ApiVersioning; - namespace OpenShock.API.Controller.Sessions; public sealed partial class SessionsController diff --git a/API/Controller/Sessions/ListSessions.cs b/API/Controller/Sessions/ListSessions.cs index 6e8157879..e8b2322ed 100644 --- a/API/Controller/Sessions/ListSessions.cs +++ b/API/Controller/Sessions/ListSessions.cs @@ -1,7 +1,6 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Response; - using OpenShock.Common.ApiVersioning; namespace OpenShock.API.Controller.Sessions; diff --git a/API/Controller/Sessions/SessionSelf.cs b/API/Controller/Sessions/SessionSelf.cs index 4fad39026..3ccab338b 100644 --- a/API/Controller/Sessions/SessionSelf.cs +++ b/API/Controller/Sessions/SessionSelf.cs @@ -1,11 +1,10 @@ using System.Diagnostics; using Microsoft.AspNetCore.Mvc; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Services; using OpenShock.Common.Redis; -using OpenShock.Common.ApiVersioning; - namespace OpenShock.API.Controller.Sessions; public sealed partial class SessionsController diff --git a/API/Controller/Shares/DeleteShareCode.cs b/API/Controller/Shares/DeleteShareCode.cs index ebf094c23..ffcccbec8 100644 --- a/API/Controller/Shares/DeleteShareCode.cs +++ b/API/Controller/Shares/DeleteShareCode.cs @@ -1,6 +1,7 @@ using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Errors; using OpenShock.Common.Extensions; using OpenShock.Common.Models; @@ -8,8 +9,6 @@ using OpenShock.Internal.Common.Problems; -using OpenShock.Common.ApiVersioning; - namespace OpenShock.API.Controller.Shares; public sealed partial class SharesController diff --git a/API/Controller/Shares/LinkShareCode.cs b/API/Controller/Shares/LinkShareCode.cs index ba3dde082..d3bf54cb5 100644 --- a/API/Controller/Shares/LinkShareCode.cs +++ b/API/Controller/Shares/LinkShareCode.cs @@ -2,6 +2,7 @@ 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; @@ -9,8 +10,6 @@ using OpenShock.Internal.Common.Problems; -using OpenShock.Common.ApiVersioning; - namespace OpenShock.API.Controller.Shares; public sealed partial class SharesController diff --git a/API/Controller/Shares/Links/AddShocker.cs b/API/Controller/Shares/Links/AddShocker.cs index dc7c87099..bcd0340b7 100644 --- a/API/Controller/Shares/Links/AddShocker.cs +++ b/API/Controller/Shares/Links/AddShocker.cs @@ -1,12 +1,12 @@ -using OpenShock.Common.ApiVersioning; +using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; -using OpenShock.Common.OpenShockDb; -using System.Net.Mime; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; -using OpenShock.Common.Problems; using OpenShock.Common.Models; +using OpenShock.Common.OpenShockDb; +using OpenShock.Common.Problems; using OpenShock.Internal.Common.Problems; diff --git a/API/Controller/Shares/Links/CreatePublicShare.cs b/API/Controller/Shares/Links/CreatePublicShare.cs index 1e6f2e007..eb1dbbd61 100644 --- a/API/Controller/Shares/Links/CreatePublicShare.cs +++ b/API/Controller/Shares/Links/CreatePublicShare.cs @@ -1,7 +1,7 @@ -using OpenShock.Common.ApiVersioning; -using System.Net.Mime; +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; diff --git a/API/Controller/Shares/Links/DeletePublicShare.cs b/API/Controller/Shares/Links/DeletePublicShare.cs index 0c8088be9..a9d47534f 100644 --- a/API/Controller/Shares/Links/DeletePublicShare.cs +++ b/API/Controller/Shares/Links/DeletePublicShare.cs @@ -1,13 +1,13 @@ -using OpenShock.Common.ApiVersioning; +using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; -using System.Net.Mime; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; -using OpenShock.Common.Problems; -using OpenShock.Common.Models; using OpenShock.Common.Extensions; +using OpenShock.Common.Models; using OpenShock.Common.OpenShockDb; +using OpenShock.Common.Problems; using OpenShock.Internal.Common.Problems; diff --git a/API/Controller/Shares/Links/EditShocker.cs b/API/Controller/Shares/Links/EditShocker.cs index e4a9a2dd2..5a355e709 100644 --- a/API/Controller/Shares/Links/EditShocker.cs +++ b/API/Controller/Shares/Links/EditShocker.cs @@ -1,8 +1,8 @@ -using OpenShock.Common.ApiVersioning; +using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; -using System.Net.Mime; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; using OpenShock.Common.OpenShockDb; diff --git a/API/Controller/Shares/Links/List.cs b/API/Controller/Shares/Links/List.cs index 06d4d44c7..23c5d0756 100644 --- a/API/Controller/Shares/Links/List.cs +++ b/API/Controller/Shares/Links/List.cs @@ -1,8 +1,8 @@ -using OpenShock.Common.ApiVersioning; -using System.Net.Mime; +using System.Net.Mime; 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; diff --git a/API/Controller/Shares/Links/PauseShocker.cs b/API/Controller/Shares/Links/PauseShocker.cs index cc65e4f7c..9798419a3 100644 --- a/API/Controller/Shares/Links/PauseShocker.cs +++ b/API/Controller/Shares/Links/PauseShocker.cs @@ -1,12 +1,12 @@ -using OpenShock.Common.ApiVersioning; +using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; using OpenShock.API.Utils; -using OpenShock.Common.Models; -using System.Net.Mime; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; +using OpenShock.Common.Models; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Problems; diff --git a/API/Controller/Shares/Links/RemoveShocker.cs b/API/Controller/Shares/Links/RemoveShocker.cs index 0f40988f2..29ed20a35 100644 --- a/API/Controller/Shares/Links/RemoveShocker.cs +++ b/API/Controller/Shares/Links/RemoveShocker.cs @@ -1,13 +1,13 @@ -using OpenShock.Common.ApiVersioning; +using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; -using System.Net.Mime; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; -using OpenShock.Common.Problems; -using OpenShock.Common.Models; using OpenShock.Common.Extensions; +using OpenShock.Common.Models; using OpenShock.Common.OpenShockDb; +using OpenShock.Common.Problems; using OpenShock.Internal.Common.Problems; diff --git a/API/Controller/Shares/UserShares/CreateShareInvite.cs b/API/Controller/Shares/UserShares/CreateShareInvite.cs index e0a009760..77ed9f40a 100644 --- a/API/Controller/Shares/UserShares/CreateShareInvite.cs +++ b/API/Controller/Shares/UserShares/CreateShareInvite.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using OpenShock.Common.ApiVersioning; 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; diff --git a/API/Controller/Shares/UserShares/GetShares.cs b/API/Controller/Shares/UserShares/GetShares.cs index 348657e59..5377d33ff 100644 --- a/API/Controller/Shares/UserShares/GetShares.cs +++ b/API/Controller/Shares/UserShares/GetShares.cs @@ -1,8 +1,8 @@ -using OpenShock.Common.ApiVersioning; -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; diff --git a/API/Controller/Shares/UserShares/Invites.cs b/API/Controller/Shares/UserShares/Invites.cs index 63424d132..a07fc743c 100644 --- a/API/Controller/Shares/UserShares/Invites.cs +++ b/API/Controller/Shares/UserShares/Invites.cs @@ -1,11 +1,11 @@ using System.Net.Mime; -using OpenShock.Common.ApiVersioning; 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; diff --git a/API/Controller/Shares/UserShares/PauseShockerShares.cs b/API/Controller/Shares/UserShares/PauseShockerShares.cs index febcc74bd..dbb4e8d2d 100644 --- a/API/Controller/Shares/UserShares/PauseShockerShares.cs +++ b/API/Controller/Shares/UserShares/PauseShockerShares.cs @@ -1,9 +1,9 @@ using System.ComponentModel.DataAnnotations; -using OpenShock.Common.ApiVersioning; 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; diff --git a/API/Controller/Shares/UserShares/RemoveShockerShares.cs b/API/Controller/Shares/UserShares/RemoveShockerShares.cs index ba10ec483..59ccacc37 100644 --- a/API/Controller/Shares/UserShares/RemoveShockerShares.cs +++ b/API/Controller/Shares/UserShares/RemoveShockerShares.cs @@ -1,8 +1,8 @@ using System.ComponentModel.DataAnnotations; -using OpenShock.Common.ApiVersioning; 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; diff --git a/API/Controller/Shares/UserShares/UpdateShockerShares.cs b/API/Controller/Shares/UserShares/UpdateShockerShares.cs index dcfdc4835..57bd51c19 100644 --- a/API/Controller/Shares/UserShares/UpdateShockerShares.cs +++ b/API/Controller/Shares/UserShares/UpdateShockerShares.cs @@ -1,9 +1,9 @@ using System.Net.Mime; -using OpenShock.Common.ApiVersioning; 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; diff --git a/API/Controller/Shockers/EditShocker.cs b/API/Controller/Shockers/EditShocker.cs index 7625ef58e..5c727be28 100644 --- a/API/Controller/Shockers/EditShocker.cs +++ b/API/Controller/Shockers/EditShocker.cs @@ -1,9 +1,9 @@ using System.Net.Mime; -using OpenShock.Common.ApiVersioning; 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; diff --git a/API/Controller/Shockers/GetShockerById.cs b/API/Controller/Shockers/GetShockerById.cs index 2d3dbdca7..50a724020 100644 --- a/API/Controller/Shockers/GetShockerById.cs +++ b/API/Controller/Shockers/GetShockerById.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using OpenShock.Common.ApiVersioning; 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.Common.Problems; diff --git a/API/Controller/Shockers/GetShockerLogs.cs b/API/Controller/Shockers/GetShockerLogs.cs index fd8e17962..21b508a23 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 OpenShock.Common.ApiVersioning; 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; diff --git a/API/Controller/Shockers/ListSharedShockers.cs b/API/Controller/Shockers/ListSharedShockers.cs index 4bbbb1066..4d68c6a29 100644 --- a/API/Controller/Shockers/ListSharedShockers.cs +++ b/API/Controller/Shockers/ListSharedShockers.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using OpenShock.Common.ApiVersioning; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Response; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Models; using OpenShock.Common.Utils; diff --git a/API/Controller/Shockers/ListShockers.cs b/API/Controller/Shockers/ListShockers.cs index 105c2840c..fe4e57432 100644 --- a/API/Controller/Shockers/ListShockers.cs +++ b/API/Controller/Shockers/ListShockers.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using OpenShock.Common.ApiVersioning; 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; diff --git a/API/Controller/Shockers/PauseShocker.cs b/API/Controller/Shockers/PauseShocker.cs index 8bca55902..7b31066f9 100644 --- a/API/Controller/Shockers/PauseShocker.cs +++ b/API/Controller/Shockers/PauseShocker.cs @@ -1,9 +1,9 @@ using System.Net.Mime; -using OpenShock.Common.ApiVersioning; 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; diff --git a/API/Controller/Shockers/RegisterShocker.cs b/API/Controller/Shockers/RegisterShocker.cs index acaa7a9cf..a351201b2 100644 --- a/API/Controller/Shockers/RegisterShocker.cs +++ b/API/Controller/Shockers/RegisterShocker.cs @@ -1,9 +1,9 @@ using System.Net.Mime; -using OpenShock.Common.ApiVersioning; 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.Constants; using OpenShock.Common.Errors; @@ -12,7 +12,6 @@ using OpenShock.Common.Problems; using OpenShock.Internal.Common.Constants; - using OpenShock.Internal.Common.Problems; namespace OpenShock.API.Controller.Shockers; diff --git a/API/Controller/Shockers/RemoveShocker.cs b/API/Controller/Shockers/RemoveShocker.cs index 4e1178f2c..be7abb1dc 100644 --- a/API/Controller/Shockers/RemoveShocker.cs +++ b/API/Controller/Shockers/RemoveShocker.cs @@ -1,8 +1,8 @@ using System.Net.Mime; -using OpenShock.Common.ApiVersioning; 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; diff --git a/API/Controller/Shockers/ShockerShares.cs b/API/Controller/Shockers/ShockerShares.cs index e1b7b155e..af65c8665 100644 --- a/API/Controller/Shockers/ShockerShares.cs +++ b/API/Controller/Shockers/ShockerShares.cs @@ -1,15 +1,15 @@ -using OpenShock.Common.ApiVersioning; +using System.Net.Mime; using Microsoft.AspNetCore.Mvc; using Microsoft.EntityFrameworkCore; using OpenShock.API.Models.Requests; using OpenShock.API.Models.Response; -using OpenShock.Common.Extensions; -using OpenShock.Common.Models; -using OpenShock.Common.OpenShockDb; -using System.Net.Mime; using OpenShock.API.Services.DeviceUpdate; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Authentication.Attributes; using OpenShock.Common.Errors; +using OpenShock.Common.Extensions; +using OpenShock.Common.Models; +using OpenShock.Common.OpenShockDb; using OpenShock.Common.Problems; using OpenShock.Internal.Common.Problems; diff --git a/API/Controller/Tokens/DeleteToken.cs b/API/Controller/Tokens/DeleteToken.cs index e97daaa7e..23b9c7901 100644 --- a/API/Controller/Tokens/DeleteToken.cs +++ b/API/Controller/Tokens/DeleteToken.cs @@ -1,9 +1,9 @@ -using OpenShock.Common.ApiVersioning; -using System.Net.Mime; +using System.Net.Mime; using System.Security.Claims; 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; diff --git a/API/Controller/Tokens/GetTokenSelf.cs b/API/Controller/Tokens/GetTokenSelf.cs index d42a35e34..b7ff4c429 100644 --- a/API/Controller/Tokens/GetTokenSelf.cs +++ b/API/Controller/Tokens/GetTokenSelf.cs @@ -1,9 +1,9 @@ using System.Diagnostics; -using OpenShock.Common.ApiVersioning; 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.Authentication.Services; diff --git a/API/Controller/Tokens/ReportTokens.cs b/API/Controller/Tokens/ReportTokens.cs index 1da01ec0c..96e57852b 100644 --- a/API/Controller/Tokens/ReportTokens.cs +++ b/API/Controller/Tokens/ReportTokens.cs @@ -1,22 +1,20 @@ using System.Drawing; -using Microsoft.AspNetCore.Mvc; -using Microsoft.EntityFrameworkCore; -using OpenShock.API.Models.Requests; -using OpenShock.Common.Problems; -using OpenShock.Common.Utils; using System.Net; using System.Net.Mime; +using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.RateLimiting; +using Microsoft.EntityFrameworkCore; using OpenShock.API.Errors; +using OpenShock.API.Models.Requests; using OpenShock.API.Services.Turnstile; +using OpenShock.Common.ApiVersioning; +using OpenShock.Common.Problems; using OpenShock.Common.Results; using OpenShock.Common.Services.Webhook; - -using OpenShock.Internal.Common.Utils; +using OpenShock.Common.Utils; using OpenShock.Internal.Common.Problems; - -using OpenShock.Common.ApiVersioning; +using OpenShock.Internal.Common.Utils; namespace OpenShock.API.Controller.Tokens; diff --git a/API/Controller/Tokens/Tokens.cs b/API/Controller/Tokens/Tokens.cs index 9d845637c..28fdab025 100644 --- a/API/Controller/Tokens/Tokens.cs +++ b/API/Controller/Tokens/Tokens.cs @@ -1,9 +1,9 @@ using System.Net.Mime; -using OpenShock.Common.ApiVersioning; 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.Extensions; using OpenShock.Common.Problems; diff --git a/API/Controller/Users/GetSelf.cs b/API/Controller/Users/GetSelf.cs index 33d5c7f42..b304bbf78 100644 --- a/API/Controller/Users/GetSelf.cs +++ b/API/Controller/Users/GetSelf.cs @@ -1,6 +1,6 @@ -using OpenShock.Common.ApiVersioning; -using System.Net.Mime; +using System.Net.Mime; using Microsoft.AspNetCore.Mvc; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Extensions; using OpenShock.Common.Models; using OpenShock.Common.OpenShockDb; diff --git a/API/Controller/Users/LookupByName.cs b/API/Controller/Users/LookupByName.cs index c3d3eebd8..236800504 100644 --- a/API/Controller/Users/LookupByName.cs +++ b/API/Controller/Users/LookupByName.cs @@ -1,7 +1,7 @@ -using OpenShock.Common.ApiVersioning; -using System.Net.Mime; +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.Common.Problems; diff --git a/API/Controller/Version/_ApiController.cs b/API/Controller/Version/_ApiController.cs index 915d8eaf1..29b2b8cc7 100644 --- a/API/Controller/Version/_ApiController.cs +++ b/API/Controller/Version/_ApiController.cs @@ -1,15 +1,15 @@ -using OpenShock.Common.ApiVersioning; -using System.Net.Mime; +using System.Net.Mime; +using System.Reflection; +using Microsoft.AspNetCore.Authentication; using Microsoft.AspNetCore.Mvc; 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; using OpenShock.Common.Utils; -using System.Reflection; -using Microsoft.AspNetCore.Authentication; using OpenShock.Internal.Common.Utils; diff --git a/Common/OpenShockServiceHelper.cs b/Common/OpenShockServiceHelper.cs index 63883532a..34e57ba29 100644 --- a/Common/OpenShockServiceHelper.cs +++ b/Common/OpenShockServiceHelper.cs @@ -1,9 +1,10 @@ using System.Net; using System.Reflection; using System.Security.Claims; +using System.Threading.RateLimiting; using Microsoft.AspNetCore.Authentication; -using Microsoft.AspNetCore.DataProtection; using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.DataProtection; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.Mvc.ApiExplorer; using Microsoft.AspNetCore.OpenApi; @@ -17,8 +18,10 @@ using OpenShock.Common.Authentication.AuthenticationHandlers; using OpenShock.Common.Authentication.Services; using OpenShock.Common.Constants; +using OpenShock.Common.Extensions; using OpenShock.Common.HealthChecks; using OpenShock.Common.JsonSerialization; +using OpenShock.Common.Metrics; using OpenShock.Common.OpenApi; using OpenShock.Common.OpenShockDb; using OpenShock.Common.Options; @@ -29,17 +32,15 @@ using OpenShock.Common.Services.RedisPubSub; using OpenShock.Common.Services.Session; using OpenShock.Common.Services.Webhook; -using OpenShock.Common.Metrics; +using OpenShock.Common.Utils; using OpenTelemetry.Metrics; using Redis.OM; using Redis.OM.Contracts; using StackExchange.Redis; -using System.Threading.RateLimiting; -using OpenShock.Common.Extensions; -using OpenShock.Common.Utils; -using OpenShock.Internal.Common.ExceptionHandling; using JsonOptions = OpenShock.Common.JsonSerialization.JsonOptions; +using OpenShock.Internal.Common.ExceptionHandling; + namespace OpenShock.Common; public static class OpenShockServiceHelper diff --git a/Common/Websocket/WebsockBaseController.cs b/Common/Websocket/WebsockBaseController.cs index 89f94a336..43659676a 100644 --- a/Common/Websocket/WebsockBaseController.cs +++ b/Common/Websocket/WebsockBaseController.cs @@ -6,12 +6,10 @@ using OpenShock.Common.Problems; using OpenShock.Common.Results; using OpenShock.Common.Utils; - using JsonOptions = OpenShock.Common.JsonSerialization.JsonOptions; -using OpenShock.Internal.Common.Utils; - using OpenShock.Internal.Common.Problems; +using OpenShock.Internal.Common.Utils; namespace OpenShock.Common.Websocket; diff --git a/LiveControlGateway/Controllers/HubV1Controller.cs b/LiveControlGateway/Controllers/HubV1Controller.cs index 2d24862ec..d2b830082 100644 --- a/LiveControlGateway/Controllers/HubV1Controller.cs +++ b/LiveControlGateway/Controllers/HubV1Controller.cs @@ -1,7 +1,7 @@ -using OpenShock.Common.ApiVersioning; -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.Hubs; using OpenShock.Common.Models; diff --git a/LiveControlGateway/Controllers/HubV2Controller.cs b/LiveControlGateway/Controllers/HubV2Controller.cs index 74093a930..0699d0b5e 100644 --- a/LiveControlGateway/Controllers/HubV2Controller.cs +++ b/LiveControlGateway/Controllers/HubV2Controller.cs @@ -1,8 +1,8 @@ -using OpenShock.Common.ApiVersioning; -using System.Diagnostics; +using System.Diagnostics; 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; diff --git a/LiveControlGateway/Controllers/InstanceDetailsController.cs b/LiveControlGateway/Controllers/InstanceDetailsController.cs index 70eb0afd7..a68bb0fa9 100644 --- a/LiveControlGateway/Controllers/InstanceDetailsController.cs +++ b/LiveControlGateway/Controllers/InstanceDetailsController.cs @@ -1,10 +1,10 @@ -using OpenShock.Common.ApiVersioning; +using System.Net.Mime; +using System.Reflection; using Microsoft.AspNetCore.Mvc; using OpenShock.Common; +using OpenShock.Common.ApiVersioning; using OpenShock.Common.Utils; using OpenShock.LiveControlGateway.Options; -using System.Net.Mime; -using System.Reflection; using OpenShock.Internal.Common.Utils; diff --git a/LiveControlGateway/Controllers/LiveControlController.cs b/LiveControlGateway/Controllers/LiveControlController.cs index 53ea72dc0..b8e041cba 100644 --- a/LiveControlGateway/Controllers/LiveControlController.cs +++ b/LiveControlGateway/Controllers/LiveControlController.cs @@ -1,11 +1,11 @@ -using OpenShock.Common.ApiVersioning; -using System.Diagnostics; +using System.Diagnostics; using System.Net.WebSockets; using System.Text.Json; using Microsoft.AspNetCore.Authorization; 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.Authentication.Services; @@ -26,11 +26,9 @@ using Results = OpenShock.Common.Results; using Timer = System.Timers.Timer; -using OpenShock.Internal.Common.Utils; - using OpenShock.Internal.Common.Constants; - using OpenShock.Internal.Common.Problems; +using OpenShock.Internal.Common.Utils; namespace OpenShock.LiveControlGateway.Controllers; From 9bbeddc69ba27e21495f4fd4f63895a465a07654 Mon Sep 17 00:00:00 2001 From: HeavenVR Date: Sun, 15 Nov 2026 12:11:07 +0100 Subject: [PATCH 4/8] refactor: put the LCG hub controllers' API version on the class HubV1Controller and HubV2Controller have no action of their own, only the Get inherited from WebsocketBaseController. [ApiVersion] may now go on a controller, where it applies to all its actions (a method attribute still takes precedence), so the hubs no longer need a Get override just to carry the version. --- Common/ApiVersioning/ApiVersionAttribute.cs | 8 ++++++-- Common/ApiVersioning/ApiVersionRouteConvention.cs | 5 +++-- LiveControlGateway/Controllers/HubV1Controller.cs | 6 +----- LiveControlGateway/Controllers/HubV2Controller.cs | 6 +----- 4 files changed, 11 insertions(+), 14 deletions(-) diff --git a/Common/ApiVersioning/ApiVersionAttribute.cs b/Common/ApiVersioning/ApiVersionAttribute.cs index 0d586d640..71232b851 100644 --- a/Common/ApiVersioning/ApiVersionAttribute.cs +++ b/Common/ApiVersioning/ApiVersionAttribute.cs @@ -4,8 +4,12 @@ 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. /// -/// An action without it is not versioned, and its route may not contain the placeholder. See . -[AttributeUsage(AttributeTargets.Method, Inherited = true)] +/// +/// 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) diff --git a/Common/ApiVersioning/ApiVersionRouteConvention.cs b/Common/ApiVersioning/ApiVersionRouteConvention.cs index 7ef1d5e21..7ccf31d97 100644 --- a/Common/ApiVersioning/ApiVersionRouteConvention.cs +++ b/Common/ApiVersioning/ApiVersionRouteConvention.cs @@ -5,7 +5,7 @@ namespace OpenShock.Common.ApiVersioning; /// /// Fills the {version:apiVersion} placeholder in the full route (controller route included) of every action with -/// : /{version:apiVersion}/account + login with [ApiVersion(1)] becomes /1/account/login. +/// , 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 @@ -23,7 +23,8 @@ public void Apply(ApplicationModel application) foreach (var action in controller.Actions) { - var version = action.ActionMethod.GetCustomAttribute(inherit: true)?.Version; + 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(); diff --git a/LiveControlGateway/Controllers/HubV1Controller.cs b/LiveControlGateway/Controllers/HubV1Controller.cs index d2b830082..de6b2d2b0 100644 --- a/LiveControlGateway/Controllers/HubV1Controller.cs +++ b/LiveControlGateway/Controllers/HubV1Controller.cs @@ -21,15 +21,11 @@ namespace OpenShock.LiveControlGateway.Controllers; /// Communication with the hubs aka ESP-32 microcontrollers /// [ApiController] +[ApiVersion(1)] [Route("/{version:apiVersion}/ws/device")] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.HubToken)] public sealed class HubV1Controller : HubControllerBase { - /// - [ApiVersion(1)] - public override Task Get([FromServices] IHostApplicationLifetime lifetime, CancellationToken cancellationToken) => - base.Get(lifetime, cancellationToken); - private readonly IHubContext _userHubContext; /// diff --git a/LiveControlGateway/Controllers/HubV2Controller.cs b/LiveControlGateway/Controllers/HubV2Controller.cs index 0699d0b5e..353c5f4e3 100644 --- a/LiveControlGateway/Controllers/HubV2Controller.cs +++ b/LiveControlGateway/Controllers/HubV2Controller.cs @@ -21,15 +21,11 @@ namespace OpenShock.LiveControlGateway.Controllers; /// Communication with the hubs aka ESP-32 microcontrollers /// [ApiController] +[ApiVersion(2)] [Route("/{version:apiVersion}/ws/hub")] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.HubToken)] public sealed class HubV2Controller : HubControllerBase { - /// - [ApiVersion(2)] - public override Task Get([FromServices] IHostApplicationLifetime lifetime, CancellationToken cancellationToken) => - base.Get(lifetime, cancellationToken); - private readonly IHubContext _userHubContext; private readonly Timer _pingTimer; private long _pingTimestamp = Stopwatch.GetTimestamp(); From 9fe5d3f069ae23c8c9b356981262930d690e282d Mon Sep 17 00:00:00 2001 From: HeavenVR Date: Sun, 15 Nov 2026 12:15:07 +0100 Subject: [PATCH 5/8] refactor: put LiveControlController's API version on the class Same as the hub controllers: its only action is the inherited Get, so the version goes on the class and the override is gone. Nothing overrides Get anymore, so WebsocketBaseController.Get is no longer virtual. --- Common/Websocket/WebsockBaseController.cs | 2 +- LiveControlGateway/Controllers/LiveControlController.cs | 6 +----- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/Common/Websocket/WebsockBaseController.cs b/Common/Websocket/WebsockBaseController.cs index 43659676a..f70a9d2bd 100644 --- a/Common/Websocket/WebsockBaseController.cs +++ b/Common/Websocket/WebsockBaseController.cs @@ -109,7 +109,7 @@ public virtual async ValueTask DisposeAsync() /// [HttpGet] [ApiExplorerSettings(IgnoreApi = true)] - public virtual async Task Get([FromServices] IHostApplicationLifetime lifetime, CancellationToken cancellationToken) + public async Task Get([FromServices] IHostApplicationLifetime lifetime, CancellationToken cancellationToken) { #pragma warning disable IDISP003 _linkedSource = CancellationTokenSource.CreateLinkedTokenSource(lifetime.ApplicationStopping, cancellationToken); diff --git a/LiveControlGateway/Controllers/LiveControlController.cs b/LiveControlGateway/Controllers/LiveControlController.cs index b8e041cba..37461b6f1 100644 --- a/LiveControlGateway/Controllers/LiveControlController.cs +++ b/LiveControlGateway/Controllers/LiveControlController.cs @@ -36,17 +36,13 @@ namespace OpenShock.LiveControlGateway.Controllers; /// Live control controller /// [ApiController] +[ApiVersion(1)] [Route("/{version:apiVersion}/ws/live/{hubId:guid}")] [TokenPermission(PermissionType.Shockers_Use)] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.UserSessionApiTokenCombo)] public sealed class LiveControlController : WebsocketBaseController>, IActionFilter { - /// - [ApiVersion(1)] - public override Task Get([FromServices] IHostApplicationLifetime lifetime, CancellationToken cancellationToken) => - base.Get(lifetime, cancellationToken); - private readonly HubLifetimeManager _hubLifetimeManager; private readonly IDbContextFactory _dbContextFactory; private readonly IUserReferenceService _userReferenceService; From 7b0f3b26bbe1525462b7599dab846e24aed1a42c Mon Sep 17 00:00:00 2001 From: HeavenVR Date: Sun, 15 Nov 2026 13:23:26 +0100 Subject: [PATCH 6/8] style: sort controller and action attributes in one order Classes: ApiController, Tags, Route, ApiVersion, Authorize, TokenPermission. Actions: Tags, NonAction, Obsolete, Http*/Route, ApiVersion, AllowAnonymous/ Authorize, TokenPermission, EnableRateLimiting, ResponseCache, EndpointName/ApiExplorerSettings, Consumes, Produces/ProducesResponseType. ApiVersion sits next to the route whose {version:apiVersion} it fills. Attributes of the same kind keep their relative order. --- API/Controller/Account/Activate.cs | 2 +- .../Account/Authenticated/ChangeEmail.cs | 2 +- .../Account/Authenticated/ChangePassword.cs | 2 +- .../Account/Authenticated/ChangeUsername.cs | 2 +- .../Account/Authenticated/Deactivate.cs | 2 +- .../Account/Authenticated/GetAuditLog.cs | 2 +- .../Account/Authenticated/GetSelf.cs | 2 +- .../Authenticated/OAuthConnectionRemove.cs | 2 +- .../Authenticated/OAuthConnectionsList.cs | 2 +- API/Controller/Account/CheckUsername.cs | 2 +- API/Controller/Account/Login.cs | 4 ++-- API/Controller/Account/LoginV2.cs | 2 +- API/Controller/Account/Logout.cs | 2 +- .../Account/PasswordResetCheckValid.cs | 4 ++-- .../Account/PasswordResetComplete.cs | 4 ++-- .../Account/PasswordResetInitiate.cs | 4 ++-- .../Account/PasswordResetInitiateV2.cs | 4 ++-- API/Controller/Account/ResendActivation.cs | 2 +- API/Controller/Account/Signup.cs | 4 ++-- API/Controller/Account/SignupV2.cs | 2 +- API/Controller/Account/VerifyEmail.cs | 4 ++-- API/Controller/Admin/AutomationTokenCreate.cs | 2 +- API/Controller/Admin/AutomationTokenDelete.cs | 2 +- API/Controller/Admin/AutomationTokenPatch.cs | 2 +- API/Controller/Admin/AutomationTokenRotate.cs | 2 +- API/Controller/Admin/Configuration.cs | 8 ++++---- API/Controller/Admin/DeactivateUser.cs | 2 +- API/Controller/Admin/DeleteApiToken.cs | 2 +- API/Controller/Admin/DeleteUser.cs | 2 +- API/Controller/Admin/EmailOutboxBulk.cs | 6 +++--- API/Controller/Admin/EmailOutboxCancel.cs | 2 +- API/Controller/Admin/EmailOutboxDelete.cs | 2 +- API/Controller/Admin/EmailOutboxList.cs | 2 +- API/Controller/Admin/EmailOutboxRequeue.cs | 2 +- API/Controller/Admin/EmailOutboxStats.cs | 2 +- API/Controller/Admin/EmailOutboxTestSend.cs | 2 +- .../Admin/EmailProviderBlacklistAdd.cs | 2 +- .../Admin/EmailProviderBlacklistRemove.cs | 2 +- API/Controller/Admin/GetAuditLog.cs | 2 +- API/Controller/Admin/GetOnlineDevices.cs | 2 +- API/Controller/Admin/GetOnlineGateways.cs | 2 +- API/Controller/Admin/GetUser.cs | 2 +- API/Controller/Admin/GetUsers.cs | 2 +- API/Controller/Admin/PatchUser.cs | 2 +- API/Controller/Admin/ReactivateUser.cs | 2 +- API/Controller/Admin/SetUserEmail.cs | 2 +- API/Controller/Admin/SetUserName.cs | 2 +- API/Controller/Admin/SetUserPassword.cs | 2 +- API/Controller/Admin/UserNameBlacklistAdd.cs | 2 +- .../Admin/UserNameBlacklistRemove.cs | 2 +- API/Controller/Admin/WebhookAdd.cs | 2 +- API/Controller/Admin/WebhookRemove.cs | 2 +- API/Controller/Device/Pair.cs | 12 ++++++------ API/Controller/Devices/DeviceOtaController.cs | 2 +- API/Controller/Devices/DevicesController.cs | 18 +++++++++--------- API/Controller/Devices/GetShockers.cs | 2 +- .../Integrations/GetControlStatChanges.cs | 2 +- API/Controller/OAuth/Authorize.cs | 4 ++-- API/Controller/OAuth/HandOff.cs | 4 ++-- API/Controller/OAuth/SignupFinalize.cs | 4 ++-- API/Controller/OAuth/SignupGetData.cs | 6 +++--- API/Controller/Public/GetStats.cs | 2 +- API/Controller/Public/PublicShareController.cs | 4 ++-- API/Controller/Sessions/DeleteSessions.cs | 2 +- API/Controller/Sessions/ListSessions.cs | 2 +- API/Controller/Shares/DeleteShareCode.cs | 2 +- API/Controller/Shares/LinkShareCode.cs | 2 +- API/Controller/Shares/Links/AddShocker.cs | 2 +- .../Shares/Links/CreatePublicShare.cs | 2 +- .../Shares/Links/DeletePublicShare.cs | 2 +- API/Controller/Shares/Links/EditShocker.cs | 4 ++-- API/Controller/Shares/Links/List.cs | 2 +- API/Controller/Shares/Links/PauseShocker.cs | 4 ++-- API/Controller/Shares/Links/RemoveShocker.cs | 2 +- .../Shares/UserShares/CreateShareInvite.cs | 4 ++-- API/Controller/Shares/UserShares/Invites.cs | 16 ++++++++-------- .../Shares/UserShares/PauseShockerShares.cs | 2 +- .../Shares/UserShares/UpdateShockerShares.cs | 2 +- API/Controller/Shockers/EditShocker.cs | 2 +- API/Controller/Shockers/GetShockerById.cs | 2 +- API/Controller/Shockers/GetShockerLogs.cs | 4 ++-- API/Controller/Shockers/PauseShocker.cs | 2 +- API/Controller/Shockers/RegisterShocker.cs | 4 ++-- API/Controller/Shockers/RemoveShocker.cs | 2 +- API/Controller/Shockers/SendControl.cs | 4 ++-- API/Controller/Shockers/ShockerShares.cs | 12 ++++++------ API/Controller/Tokens/DeleteToken.cs | 2 +- API/Controller/Tokens/ReportTokens.cs | 2 +- API/Controller/Tokens/Tokens.cs | 14 +++++++------- API/Controller/Users/GetSelf.cs | 2 +- API/Controller/Users/GetSelfControlStats.cs | 2 +- API/Controller/Users/LookupByName.cs | 2 +- API/Controller/Version/_ApiController.cs | 4 ++-- .../Controllers/HubV1Controller.cs | 2 +- .../Controllers/HubV2Controller.cs | 2 +- .../Controllers/InstanceDetailsController.cs | 2 +- .../Controllers/LiveControlController.cs | 4 ++-- 97 files changed, 154 insertions(+), 154 deletions(-) diff --git a/API/Controller/Account/Activate.cs b/API/Controller/Account/Activate.cs index 9693d8b44..e37090bfd 100644 --- a/API/Controller/Account/Activate.cs +++ b/API/Controller/Account/Activate.cs @@ -12,9 +12,9 @@ public sealed partial class AccountController /// Activate account /// [HttpPost("activate")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] - [ApiVersion(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 aefde08d3..42b31a7de 100644 --- a/API/Controller/Account/Authenticated/ChangeEmail.cs +++ b/API/Controller/Account/Authenticated/ChangeEmail.cs @@ -20,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 @@ -28,7 +29,6 @@ public sealed partial class AuthenticatedAccountController [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] // EmailChangeAlreadyInUse [ProducesResponseType(StatusCodes.Status429TooManyRequests, MediaTypeNames.Application.ProblemJson)] // EmailChangeTooMany // notActivated / deactivated / notFound are blocked by UserSessionAuthentication before reaching this controller. - [ApiVersion(1)] public async Task ChangeEmail([FromBody] ChangeEmailRequest body, CancellationToken cancellationToken) { if (string.IsNullOrEmpty(CurrentUser.PasswordHash)) diff --git a/API/Controller/Account/Authenticated/ChangePassword.cs b/API/Controller/Account/Authenticated/ChangePassword.cs index 076e17e38..8d562b533 100644 --- a/API/Controller/Account/Authenticated/ChangePassword.cs +++ b/API/Controller/Account/Authenticated/ChangePassword.cs @@ -20,12 +20,12 @@ public sealed partial class AuthenticatedAccountController /// /// [HttpPost("password")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] // PasswordChangeInvalidPassword [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] // PasswordNotSet // notActivated / deactivated / notFound are blocked by UserSessionAuthentication before reaching this controller. - [ApiVersion(1)] public async Task ChangePassword([FromBody] ChangePasswordRequest body, CancellationToken cancellationToken) { // OAuth-only accounts that have never set a password must go through the email-confirmed diff --git a/API/Controller/Account/Authenticated/ChangeUsername.cs b/API/Controller/Account/Authenticated/ChangeUsername.cs index 2d5989d57..18e35219e 100644 --- a/API/Controller/Account/Authenticated/ChangeUsername.cs +++ b/API/Controller/Account/Authenticated/ChangeUsername.cs @@ -21,12 +21,12 @@ public sealed partial class AuthenticatedAccountController /// /// [HttpPost("username")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status409Conflict, MediaTypeNames.Application.ProblemJson)] // UsernameTaken [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // UsernameInvalid [ProducesResponseType(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] // UsernameRecentlyChanged - [ApiVersion(1)] public async Task ChangeUsername([FromBody] ChangeUsernameRequest body, CancellationToken cancellationToken) { var result = await _accountService.ChangeUsernameAsync(CurrentUser.Id, body.Username, actorId: CurrentUser.Id, diff --git a/API/Controller/Account/Authenticated/Deactivate.cs b/API/Controller/Account/Authenticated/Deactivate.cs index da18838d1..3feee0a3c 100644 --- a/API/Controller/Account/Authenticated/Deactivate.cs +++ b/API/Controller/Account/Authenticated/Deactivate.cs @@ -16,9 +16,9 @@ public sealed partial class AuthenticatedAccountController /// /// Done. [HttpDelete] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status204NoContent)] [ProducesResponseType(StatusCodes.Status403Forbidden, MediaTypeNames.Application.ProblemJson)] // CannotDeactivatePrivledgedAccount - [ApiVersion(1)] public async Task Deactivate(CancellationToken cancellationToken) { var deactivationResult = await _accountService.DeactivateAccountAsync(CurrentUser.Id, CurrentUser.Id, deleteLater: true, cancellationToken: cancellationToken); diff --git a/API/Controller/Account/Authenticated/GetAuditLog.cs b/API/Controller/Account/Authenticated/GetAuditLog.cs index 97d75d70f..eb9d8251d 100644 --- a/API/Controller/Account/Authenticated/GetAuditLog.cs +++ b/API/Controller/Account/Authenticated/GetAuditLog.cs @@ -19,8 +19,8 @@ public sealed partial class AuthenticatedAccountController /// /// A page of audit log entries. [HttpGet("audit-log")] - [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ApiVersion(1)] + [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task> GetAuditLog( [FromQuery] PaginationQuery pagination, [FromServices] IAuditService auditService, diff --git a/API/Controller/Account/Authenticated/GetSelf.cs b/API/Controller/Account/Authenticated/GetSelf.cs index f5ae14dad..31305e8bf 100644 --- a/API/Controller/Account/Authenticated/GetSelf.cs +++ b/API/Controller/Account/Authenticated/GetSelf.cs @@ -16,9 +16,9 @@ public sealed partial class AuthenticatedAccountController /// /// The account information was successfully retrieved. [HttpGet] + [ApiVersion(1)] [Authorize(AuthenticationSchemes = OpenShockAuthSchemes.UserSessionApiTokenCombo)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] - [ApiVersion(1)] public UserSelfResponse GetSelf() => new() { Id = CurrentUser.Id, diff --git a/API/Controller/Account/Authenticated/OAuthConnectionRemove.cs b/API/Controller/Account/Authenticated/OAuthConnectionRemove.cs index 72eb84af1..9796a6cfc 100644 --- a/API/Controller/Account/Authenticated/OAuthConnectionRemove.cs +++ b/API/Controller/Account/Authenticated/OAuthConnectionRemove.cs @@ -15,9 +15,9 @@ public sealed partial class AuthenticatedAccountController /// Connection removed. /// No connection found for this provider. [HttpDelete("connections/{provider}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status204NoContent)] [ProducesResponseType(StatusCodes.Status404NotFound)] - [ApiVersion(1)] public async Task RemoveOAuthConnection([FromRoute] string provider, [FromServices] IOAuthConnectionService connectionService, CancellationToken cancellationToken) { var deleted = await connectionService.TryRemoveConnectionAsync(CurrentUser.Id, provider, actorId: CurrentUser.Id, cancellationToken); diff --git a/API/Controller/Account/Authenticated/OAuthConnectionsList.cs b/API/Controller/Account/Authenticated/OAuthConnectionsList.cs index c8546bd1f..82666c1b9 100644 --- a/API/Controller/Account/Authenticated/OAuthConnectionsList.cs +++ b/API/Controller/Account/Authenticated/OAuthConnectionsList.cs @@ -15,8 +15,8 @@ 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")] - [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ApiVersion(1)] + [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public IActionResult ListOAuthConnections([FromServices] IOAuthConnectionService connectionService, CancellationToken cancellationToken) { return Ok(connectionService diff --git a/API/Controller/Account/CheckUsername.cs b/API/Controller/Account/CheckUsername.cs index 88a1d21e3..b96d47894 100644 --- a/API/Controller/Account/CheckUsername.cs +++ b/API/Controller/Account/CheckUsername.cs @@ -17,8 +17,8 @@ public sealed partial class AccountController /// /// /// - [ApiVersion(1)] [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 dcf64bd34..8f07a1d8e 100644 --- a/API/Controller/Account/Login.cs +++ b/API/Controller/Account/Login.cs @@ -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.")] - [ApiExplorerSettings(IgnoreApi = true)] + [HttpPost("login")] [ApiVersion(1)] + [ApiExplorerSettings(IgnoreApi = true)] 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 3cf18f200..0b1b80be8 100644 --- a/API/Controller/Account/LoginV2.cs +++ b/API/Controller/Account/LoginV2.cs @@ -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 - [ApiVersion(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 766e7c249..2fe49ce3e 100644 --- a/API/Controller/Account/Logout.cs +++ b/API/Controller/Account/Logout.cs @@ -8,8 +8,8 @@ namespace OpenShock.API.Controller.Account; public sealed partial class AccountController { [HttpPost("logout")] - [ProducesResponseType(StatusCodes.Status200OK)] [ApiVersion(1)] + [ProducesResponseType(StatusCodes.Status200OK)] 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 42382b84d..0820cd33e 100644 --- a/API/Controller/Account/PasswordResetCheckValid.cs +++ b/API/Controller/Account/PasswordResetCheckValid.cs @@ -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}")] - [ApiExplorerSettings(IgnoreApi = true)] [ApiVersion(1)] + [ApiExplorerSettings(IgnoreApi = true)] 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 - [ApiVersion(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 314cc7da1..158378fdb 100644 --- a/API/Controller/Account/PasswordResetComplete.cs +++ b/API/Controller/Account/PasswordResetComplete.cs @@ -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}")] - [ApiExplorerSettings(IgnoreApi = true)] [ApiVersion(1)] + [ApiExplorerSettings(IgnoreApi = true)] 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 - [ApiVersion(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 4e79a58df..84a1e9cb3 100644 --- a/API/Controller/Account/PasswordResetInitiate.cs +++ b/API/Controller/Account/PasswordResetInitiate.cs @@ -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.")] - [ApiExplorerSettings(IgnoreApi = true)] + [HttpPost("reset")] [ApiVersion(1)] + [ApiExplorerSettings(IgnoreApi = true)] 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 c8598a411..560805bcf 100644 --- a/API/Controller/Account/PasswordResetInitiateV2.cs +++ b/API/Controller/Account/PasswordResetInitiateV2.cs @@ -18,8 +18,8 @@ public sealed partial class AccountController /// [Obsolete("Retired. Use POST /2/account/password-reset instead.")] [HttpPost("reset-password")] - [ApiExplorerSettings(IgnoreApi = true)] [ApiVersion(2)] + [ApiExplorerSettings(IgnoreApi = true)] 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)] - [ApiVersion(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 3fb87dafb..9054b0003 100644 --- a/API/Controller/Account/ResendActivation.cs +++ b/API/Controller/Account/ResendActivation.cs @@ -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")] - [EnableRateLimiting("auth")] [ApiVersion(1)] + [EnableRateLimiting("auth")] [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 682caafc3..4a8c31e5c 100644 --- a/API/Controller/Account/Signup.cs +++ b/API/Controller/Account/Signup.cs @@ -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.")] - [ApiExplorerSettings(IgnoreApi = true)] + [HttpPost("signup")] [ApiVersion(1)] + [ApiExplorerSettings(IgnoreApi = true)] 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 1828f81d6..8871bb453 100644 --- a/API/Controller/Account/SignupV2.cs +++ b/API/Controller/Account/SignupV2.cs @@ -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 - [ApiVersion(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 f4ac848ab..0e5ee0ea1 100644 --- a/API/Controller/Account/VerifyEmail.cs +++ b/API/Controller/Account/VerifyEmail.cs @@ -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)] - [ApiVersion(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)] - [ApiVersion(1)] public Task EmailVerifyLegacy([FromQuery(Name = "token")] string token, CancellationToken cancellationToken) => VerifyPendingEmailChange(token, cancellationToken); diff --git a/API/Controller/Admin/AutomationTokenCreate.cs b/API/Controller/Admin/AutomationTokenCreate.cs index 0c6094333..7391799fe 100644 --- a/API/Controller/Admin/AutomationTokenCreate.cs +++ b/API/Controller/Admin/AutomationTokenCreate.cs @@ -16,9 +16,9 @@ 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)] - [ApiVersion(1)] public async Task CreateAutomationToken( [FromBody] CreateAutomationTokenDto body, [FromServices] IAuditService auditService, diff --git a/API/Controller/Admin/AutomationTokenDelete.cs b/API/Controller/Admin/AutomationTokenDelete.cs index af8b10993..e59d24475 100644 --- a/API/Controller/Admin/AutomationTokenDelete.cs +++ b/API/Controller/Admin/AutomationTokenDelete.cs @@ -15,10 +15,10 @@ public sealed partial class AdminController /// accounts holds a privileged role /// [HttpDelete("automationTokens/{id}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] [ProducesResponseType(StatusCodes.Status409Conflict)] - [ApiVersion(1)] public async Task DeleteAutomationToken( [FromRoute] Guid id, [FromServices] IAuditService auditService, diff --git a/API/Controller/Admin/AutomationTokenPatch.cs b/API/Controller/Admin/AutomationTokenPatch.cs index 2200a18a9..68e959a3a 100644 --- a/API/Controller/Admin/AutomationTokenPatch.cs +++ b/API/Controller/Admin/AutomationTokenPatch.cs @@ -15,10 +15,10 @@ public sealed partial class AdminController /// Updates an automation token /// [HttpPatch("automationTokens/{id}")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] - [ApiVersion(1)] public async Task PatchAutomationToken( [FromRoute] Guid id, [FromBody] PatchAutomationTokenDto body, diff --git a/API/Controller/Admin/AutomationTokenRotate.cs b/API/Controller/Admin/AutomationTokenRotate.cs index fa86d049d..6e7f65b6d 100644 --- a/API/Controller/Admin/AutomationTokenRotate.cs +++ b/API/Controller/Admin/AutomationTokenRotate.cs @@ -16,9 +16,9 @@ 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)] - [ApiVersion(1)] public async Task RotateAutomationToken( [FromRoute] Guid id, [FromServices] IAuditService auditService, diff --git a/API/Controller/Admin/Configuration.cs b/API/Controller/Admin/Configuration.cs index 3b2f206af..7cadefc22 100644 --- a/API/Controller/Admin/Configuration.cs +++ b/API/Controller/Admin/Configuration.cs @@ -17,8 +17,8 @@ public sealed partial class AdminController /// /// Unauthorized [HttpGet("config")] - [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] // Ok [ApiVersion(1)] + [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] // Ok public IAsyncEnumerable ConfigurationList([FromServices] IConfigurationService configurationService) { PedanticallyEnsureAdmin(); @@ -45,11 +45,11 @@ 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 [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // InvalidNameFormat, InvalidValueFormat - [ApiVersion(1)] public async Task ConfigurationAdd([FromBody] ConfigurationAddItemRequest body, [FromServices] IConfigurationService configurationService, CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); @@ -79,12 +79,12 @@ 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 [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // Not found [ProducesResponseType(StatusCodes.Status400BadRequest, MediaTypeNames.Application.ProblemJson)] // InvalidNameFormat, InvalidValueFormat - [ApiVersion(1)] public async Task ConfigurationUpdate([FromBody] ConfigurationUpdateItemRequest body, [FromServices] IConfigurationService configurationService, CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); @@ -113,10 +113,10 @@ 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 - [ApiVersion(1)] public async Task ConfigurationDelete([FromRoute] string name, [FromServices] IConfigurationService configurationService, CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/DeactivateUser.cs b/API/Controller/Admin/DeactivateUser.cs index 1651ee1d3..9660fd02c 100644 --- a/API/Controller/Admin/DeactivateUser.cs +++ b/API/Controller/Admin/DeactivateUser.cs @@ -16,8 +16,8 @@ public sealed partial class AdminController /// OK /// Unauthorized [HttpPut("users/{userId}/deactivate")] - [ProducesResponseType(StatusCodes.Status200OK)] [ApiVersion(1)] + [ProducesResponseType(StatusCodes.Status200OK)] public async Task DeactivateUser( [FromRoute] Guid userId, [FromQuery(Name = "deleteLater")] bool deleteLater, diff --git a/API/Controller/Admin/DeleteApiToken.cs b/API/Controller/Admin/DeleteApiToken.cs index 7e9e6ed80..0c9db03cb 100644 --- a/API/Controller/Admin/DeleteApiToken.cs +++ b/API/Controller/Admin/DeleteApiToken.cs @@ -12,8 +12,8 @@ public sealed partial class AdminController /// OK /// Unauthorized [HttpDelete("apitokens/{tokenId}")] - [ProducesResponseType(StatusCodes.Status200OK)] [ApiVersion(1)] + [ProducesResponseType(StatusCodes.Status200OK)] public async Task DeleteApiToken([FromRoute] Guid tokenId, [FromServices] IApiTokenService apiTokenService, CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/DeleteUser.cs b/API/Controller/Admin/DeleteUser.cs index a60b2c0aa..667b99023 100644 --- a/API/Controller/Admin/DeleteUser.cs +++ b/API/Controller/Admin/DeleteUser.cs @@ -16,8 +16,8 @@ public sealed partial class AdminController /// OK /// Unauthorized [HttpDelete("users/{userId}")] - [ProducesResponseType(StatusCodes.Status200OK)] [ApiVersion(1)] + [ProducesResponseType(StatusCodes.Status200OK)] public async Task DeleteUser( [FromRoute] Guid userId, [FromQuery][MaxLength(ApiHardLimits.AuditReasonMaxLength)] string? reason, diff --git a/API/Controller/Admin/EmailOutboxBulk.cs b/API/Controller/Admin/EmailOutboxBulk.cs index a8ccd1e82..152e277f1 100644 --- a/API/Controller/Admin/EmailOutboxBulk.cs +++ b/API/Controller/Admin/EmailOutboxBulk.cs @@ -18,9 +18,9 @@ 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)] - [ApiVersion(1)] public async Task BulkRequeueEmailOutbox([FromBody] EmailOutboxBulkRequest body, [FromServices] IRedisPubService redisPubService, CancellationToken ct) { PedanticallyEnsureAdmin(); @@ -53,9 +53,9 @@ 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)] - [ApiVersion(1)] public async Task BulkCancelEmailOutbox([FromBody] EmailOutboxBulkRequest body, CancellationToken ct) { PedanticallyEnsureAdmin(); @@ -76,9 +76,9 @@ 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)] - [ApiVersion(1)] public async Task BulkDeleteEmailOutbox([FromBody] EmailOutboxBulkRequest body, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/EmailOutboxCancel.cs b/API/Controller/Admin/EmailOutboxCancel.cs index dd2ec6314..bb5a4a2ad 100644 --- a/API/Controller/Admin/EmailOutboxCancel.cs +++ b/API/Controller/Admin/EmailOutboxCancel.cs @@ -16,10 +16,10 @@ 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)] - [ApiVersion(1)] public async Task CancelEmailOutbox([FromRoute] Guid id, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/EmailOutboxDelete.cs b/API/Controller/Admin/EmailOutboxDelete.cs index 5f2f2019c..785677af0 100644 --- a/API/Controller/Admin/EmailOutboxDelete.cs +++ b/API/Controller/Admin/EmailOutboxDelete.cs @@ -14,9 +14,9 @@ public sealed partial class AdminController /// Unauthorized /// No such message [HttpDelete("email/outbox/{id}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] - [ApiVersion(1)] public async Task DeleteEmailOutbox([FromRoute] Guid id, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/EmailOutboxList.cs b/API/Controller/Admin/EmailOutboxList.cs index a73aefb4d..1c47e3c65 100644 --- a/API/Controller/Admin/EmailOutboxList.cs +++ b/API/Controller/Admin/EmailOutboxList.cs @@ -21,8 +21,8 @@ public sealed partial class AdminController /// Paginated email outbox messages /// Unauthorized [HttpGet("email/outbox")] - [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ApiVersion(1)] + [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task GetEmailOutbox( [FromQuery(Name = "$filter")] string filterQuery = "", [FromQuery(Name = "$orderby")] string orderbyQuery = "", diff --git a/API/Controller/Admin/EmailOutboxRequeue.cs b/API/Controller/Admin/EmailOutboxRequeue.cs index 72aa223de..befe5475a 100644 --- a/API/Controller/Admin/EmailOutboxRequeue.cs +++ b/API/Controller/Admin/EmailOutboxRequeue.cs @@ -17,10 +17,10 @@ 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)] - [ApiVersion(1)] public async Task RequeueEmailOutbox([FromRoute] Guid id, [FromServices] IRedisPubService redisPubService, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/EmailOutboxStats.cs b/API/Controller/Admin/EmailOutboxStats.cs index a6457b7ac..03a7e6f11 100644 --- a/API/Controller/Admin/EmailOutboxStats.cs +++ b/API/Controller/Admin/EmailOutboxStats.cs @@ -15,8 +15,8 @@ public sealed partial class AdminController /// Per-status counts /// Unauthorized [HttpGet("email/outbox/stats")] - [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ApiVersion(1)] + [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task GetEmailOutboxStats(CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/EmailOutboxTestSend.cs b/API/Controller/Admin/EmailOutboxTestSend.cs index 2bda94bff..a1db75d74 100644 --- a/API/Controller/Admin/EmailOutboxTestSend.cs +++ b/API/Controller/Admin/EmailOutboxTestSend.cs @@ -18,10 +18,10 @@ 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)] - [ApiVersion(1)] public async Task SendTestEmail([FromBody] SendTestEmailDto body, [FromServices] IRedisPubService redisPubService, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/EmailProviderBlacklistAdd.cs b/API/Controller/Admin/EmailProviderBlacklistAdd.cs index 2a22bbd01..d5d1b7370 100644 --- a/API/Controller/Admin/EmailProviderBlacklistAdd.cs +++ b/API/Controller/Admin/EmailProviderBlacklistAdd.cs @@ -10,9 +10,9 @@ namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController { [HttpPost("blacklist/emailProviders")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] - [ApiVersion(1)] public async Task AddEmailProviderBlacklist([FromBody] AddEmailProviderBlacklistDto body, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/EmailProviderBlacklistRemove.cs b/API/Controller/Admin/EmailProviderBlacklistRemove.cs index eaa0fb052..03327bcf5 100644 --- a/API/Controller/Admin/EmailProviderBlacklistRemove.cs +++ b/API/Controller/Admin/EmailProviderBlacklistRemove.cs @@ -7,9 +7,9 @@ namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController { [HttpDelete("blacklist/emailProviders/{id}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] - [ApiVersion(1)] public async Task RemoveEmailProviderBlacklist([FromRoute] Guid id, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/GetAuditLog.cs b/API/Controller/Admin/GetAuditLog.cs index 430dc9bfa..20db8b3d3 100644 --- a/API/Controller/Admin/GetAuditLog.cs +++ b/API/Controller/Admin/GetAuditLog.cs @@ -20,8 +20,8 @@ public sealed partial class AdminController /// /// A page of audit log entries. [HttpGet("audit-log")] - [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ApiVersion(1)] + [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task> GetAdminAuditLog( [FromQuery] PaginationQuery pagination, [FromQuery] Guid? userId, diff --git a/API/Controller/Admin/GetOnlineDevices.cs b/API/Controller/Admin/GetOnlineDevices.cs index 48e3f12e9..82df01596 100644 --- a/API/Controller/Admin/GetOnlineDevices.cs +++ b/API/Controller/Admin/GetOnlineDevices.cs @@ -20,8 +20,8 @@ public sealed partial class AdminController /// All online devices /// Unauthorized [HttpGet("monitoring/onlineDevices")] - [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ApiVersion(1)] + [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task GetOnlineDevices(CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/GetOnlineGateways.cs b/API/Controller/Admin/GetOnlineGateways.cs index f5b70e54a..ec2f411fa 100644 --- a/API/Controller/Admin/GetOnlineGateways.cs +++ b/API/Controller/Admin/GetOnlineGateways.cs @@ -13,8 +13,8 @@ public sealed partial class AdminController /// All online gateways /// Unauthorized [HttpGet("monitoring/gateways")] - [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ApiVersion(1)] + [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task GetOnlineGateways() { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/GetUser.cs b/API/Controller/Admin/GetUser.cs index d5f9e93d2..32e269beb 100644 --- a/API/Controller/Admin/GetUser.cs +++ b/API/Controller/Admin/GetUser.cs @@ -238,9 +238,9 @@ public sealed class AdminUserView /// Not found /// Unauthorized [HttpGet("users/{userId}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound)] - [ApiVersion(1)] public async Task GetUserById([FromRoute(Name = "userId")] Guid userId, CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/GetUsers.cs b/API/Controller/Admin/GetUsers.cs index 0cd48b852..df85dd13e 100644 --- a/API/Controller/Admin/GetUsers.cs +++ b/API/Controller/Admin/GetUsers.cs @@ -20,8 +20,8 @@ public sealed partial class AdminController /// Paginated users /// Unauthorized [HttpGet("users")] - [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ApiVersion(1)] + [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task GetUsers( [FromQuery(Name = "$filter")] string filterQuery = "", [FromQuery(Name = "$orderby")] string orderbyQuery = "", diff --git a/API/Controller/Admin/PatchUser.cs b/API/Controller/Admin/PatchUser.cs index 8648610bc..05b5538c4 100644 --- a/API/Controller/Admin/PatchUser.cs +++ b/API/Controller/Admin/PatchUser.cs @@ -15,9 +15,9 @@ public sealed partial class AdminController /// Not found /// Unauthorized [HttpPatch("users/{userId}")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] - [ApiVersion(1)] public async Task ModifyUser([FromRoute] Guid userId, [FromBody] UserPatchDto body, [FromServices] IAccountService accountService, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/ReactivateUser.cs b/API/Controller/Admin/ReactivateUser.cs index bc8ae873a..10f6db79c 100644 --- a/API/Controller/Admin/ReactivateUser.cs +++ b/API/Controller/Admin/ReactivateUser.cs @@ -16,8 +16,8 @@ public sealed partial class AdminController /// OK /// Unauthorized [HttpPut("users/{userId}/reactivate")] - [ProducesResponseType(StatusCodes.Status200OK)] [ApiVersion(1)] + [ProducesResponseType(StatusCodes.Status200OK)] public async Task ReactivateUser( [FromRoute] Guid userId, [FromQuery][MaxLength(ApiHardLimits.AuditReasonMaxLength)] string? reason, diff --git a/API/Controller/Admin/SetUserEmail.cs b/API/Controller/Admin/SetUserEmail.cs index ae1f9a7f0..49252369c 100644 --- a/API/Controller/Admin/SetUserEmail.cs +++ b/API/Controller/Admin/SetUserEmail.cs @@ -17,9 +17,9 @@ public sealed partial class AdminController /// Not found /// Unauthorized [HttpPut("users/{userId}/email")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] - [ApiVersion(1)] public async Task SetUserEmail([FromRoute(Name = "userId")] Guid userId, [FromBody] SetUserEmailRequestBody body, [FromServices] IAccountService accountService, CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/SetUserName.cs b/API/Controller/Admin/SetUserName.cs index 503c4fe58..b3e603ecb 100644 --- a/API/Controller/Admin/SetUserName.cs +++ b/API/Controller/Admin/SetUserName.cs @@ -21,10 +21,10 @@ 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)] - [ApiVersion(1)] public async Task SetUserName([FromRoute(Name = "userId")] Guid userId, [FromBody] SetUserNameRequestBody body, [FromServices] IAccountService accountService, CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/SetUserPassword.cs b/API/Controller/Admin/SetUserPassword.cs index 45603c6a9..3b30ce163 100644 --- a/API/Controller/Admin/SetUserPassword.cs +++ b/API/Controller/Admin/SetUserPassword.cs @@ -20,10 +20,10 @@ 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)] - [ApiVersion(1)] public async Task SetUserPassword([FromRoute(Name = "userId")] Guid userId, [FromBody] SetUserPasswordRequestBody body, [FromServices] IAccountService accountService, CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/UserNameBlacklistAdd.cs b/API/Controller/Admin/UserNameBlacklistAdd.cs index 5847823c4..83feb5869 100644 --- a/API/Controller/Admin/UserNameBlacklistAdd.cs +++ b/API/Controller/Admin/UserNameBlacklistAdd.cs @@ -9,9 +9,9 @@ namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController { [HttpPost("blacklist/usernames")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] - [ApiVersion(1)] public async Task AddUsernameBlacklist([FromBody] AddUsernameBlacklistDto body, CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/UserNameBlacklistRemove.cs b/API/Controller/Admin/UserNameBlacklistRemove.cs index 53f58e678..b98772c62 100644 --- a/API/Controller/Admin/UserNameBlacklistRemove.cs +++ b/API/Controller/Admin/UserNameBlacklistRemove.cs @@ -7,9 +7,9 @@ namespace OpenShock.API.Controller.Admin; public sealed partial class AdminController { [HttpDelete("blacklist/usernames/{id}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] - [ApiVersion(1)] public async Task RemoveUsernameBlacklist([FromRoute] Guid id, CancellationToken ct) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/WebhookAdd.cs b/API/Controller/Admin/WebhookAdd.cs index 001e6df91..3abd30588 100644 --- a/API/Controller/Admin/WebhookAdd.cs +++ b/API/Controller/Admin/WebhookAdd.cs @@ -17,10 +17,10 @@ public sealed partial class AdminController /// OK /// Unauthorized [HttpPost("webhooks")] + [ApiVersion(1)] [Consumes(MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] - [ApiVersion(1)] public async Task AddWebhook([FromBody] AddWebhookDto body, [FromServices] IWebhookService webhookService, CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Admin/WebhookRemove.cs b/API/Controller/Admin/WebhookRemove.cs index c2d03b798..843d97019 100644 --- a/API/Controller/Admin/WebhookRemove.cs +++ b/API/Controller/Admin/WebhookRemove.cs @@ -13,9 +13,9 @@ public sealed partial class AdminController /// OK /// Unauthorized [HttpDelete("webhooks/{id}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] - [ApiVersion(1)] public async Task RemoveWebhook([FromRoute] Guid id, [FromServices] IWebhookService webhookService, CancellationToken cancellationToken) { PedanticallyEnsureAdmin(); diff --git a/API/Controller/Device/Pair.cs b/API/Controller/Device/Pair.cs index a11cba70a..64b32b484 100644 --- a/API/Controller/Device/Pair.cs +++ b/API/Controller/Device/Pair.cs @@ -20,11 +20,11 @@ public sealed partial class DeviceController /// /// Successfully assigned LCG node /// No such pair code exists - [AllowAnonymous] - [ApiVersion(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] - [ApiVersion(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/Devices/DeviceOtaController.cs b/API/Controller/Devices/DeviceOtaController.cs index ebfb3bdf3..63171e8b7 100644 --- a/API/Controller/Devices/DeviceOtaController.cs +++ b/API/Controller/Devices/DeviceOtaController.cs @@ -38,9 +38,9 @@ public DevicesOtaController(OpenShockContext db, ILogger logg /// OK /// Could not find device or you do not have access to it [HttpGet("{deviceId}/ota")] + [ApiVersion(1)] [ProducesResponseType>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound - [ApiVersion(1)] public async Task GetOtaUpdateHistory([FromRoute] Guid deviceId, [FromServices] IOtaService otaService, CancellationToken cancellationToken) { // Check if user owns device or has a share diff --git a/API/Controller/Devices/DevicesController.cs b/API/Controller/Devices/DevicesController.cs index f58443fa4..b5ecddeb0 100644 --- a/API/Controller/Devices/DevicesController.cs +++ b/API/Controller/Devices/DevicesController.cs @@ -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 - [ApiVersion(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 - [ApiVersion(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 - [ApiVersion(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 - [ApiVersion(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)] - [ApiVersion(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)] - [ApiVersion(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 - [ApiVersion(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 - [ApiVersion(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 - [ApiVersion(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 905a85e48..bab8d4cf9 100644 --- a/API/Controller/Devices/GetShockers.cs +++ b/API/Controller/Devices/GetShockers.cs @@ -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 - [ApiVersion(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/Integrations/GetControlStatChanges.cs b/API/Controller/Integrations/GetControlStatChanges.cs index 563408ef3..21bc35465 100644 --- a/API/Controller/Integrations/GetControlStatChanges.cs +++ b/API/Controller/Integrations/GetControlStatChanges.cs @@ -29,10 +29,10 @@ 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 - [ApiVersion(1)] public async Task GetControlStatChanges(ControlStatChangesRequest body, CancellationToken cancellationToken) { if (!HttpContext.IsBypassed(AutomationTokenType.ControlStatsRead)) diff --git a/API/Controller/OAuth/Authorize.cs b/API/Controller/OAuth/Authorize.cs index b9f2508ec..28d4a13de 100644 --- a/API/Controller/OAuth/Authorize.cs +++ b/API/Controller/OAuth/Authorize.cs @@ -19,9 +19,9 @@ public sealed partial class OAuthController /// Flow to run /// Redirect to the provider authorization page. /// Unsupported or misconfigured provider. - [EnableRateLimiting("auth")] - [ApiVersion(1)] [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 d9ab82bea..89a22a441 100644 --- a/API/Controller/OAuth/HandOff.cs +++ b/API/Controller/OAuth/HandOff.cs @@ -20,9 +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")] - [ApiVersion(1)] [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 d2ad5f8a4..9943cad7a 100644 --- a/API/Controller/OAuth/SignupFinalize.cs +++ b/API/Controller/OAuth/SignupFinalize.cs @@ -29,9 +29,9 @@ public sealed partial class OAuthController /// /// /// - [EnableRateLimiting("auth")] - [ApiVersion(1)] [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 5ad91a3dd..fa9968fbb 100644 --- a/API/Controller/OAuth/SignupGetData.cs +++ b/API/Controller/OAuth/SignupGetData.cs @@ -20,10 +20,10 @@ public sealed partial class OAuthController /// who initiated the flow. /// /// The provider key (e.g. discord). - [ResponseCache(NoStore = true)] - [EnableRateLimiting("auth")] - [ApiVersion(1)] [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/Public/GetStats.cs b/API/Controller/Public/GetStats.cs index 70edb39b1..48170a185 100644 --- a/API/Controller/Public/GetStats.cs +++ b/API/Controller/Public/GetStats.cs @@ -15,8 +15,8 @@ public sealed partial class PublicController /// /// The statistics were successfully retrieved. [Tags("Meta")] - [ApiVersion(1)] [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 5b4fb2654..fa5c71ce6 100644 --- a/API/Controller/Public/PublicShareController.cs +++ b/API/Controller/Public/PublicShareController.cs @@ -20,9 +20,9 @@ public sealed partial class PublicController /// /// The public share information was successfully retrieved. /// The public share does not exist. - [ApiVersion(1)] - [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 098eafdf3..e52cfe53b 100644 --- a/API/Controller/Sessions/DeleteSessions.cs +++ b/API/Controller/Sessions/DeleteSessions.cs @@ -11,9 +11,9 @@ namespace OpenShock.API.Controller.Sessions; public sealed partial class SessionsController { [HttpDelete("{sessionId}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // SessionNotFound - [ApiVersion(1)] public async Task DeleteSession([FromRoute] Guid sessionId) { var loginSession = await _sessionService.GetSessionByIdAsync(sessionId); diff --git a/API/Controller/Sessions/ListSessions.cs b/API/Controller/Sessions/ListSessions.cs index 97dd39eca..84a2e277d 100644 --- a/API/Controller/Sessions/ListSessions.cs +++ b/API/Controller/Sessions/ListSessions.cs @@ -8,8 +8,8 @@ namespace OpenShock.API.Controller.Sessions; public sealed partial class SessionsController { [HttpGet] - [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ApiVersion(1)] + [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public IAsyncEnumerable ListSessions() { return _sessionService.ListSessionsByUserIdAsync(CurrentUser.Id) diff --git a/API/Controller/Shares/DeleteShareCode.cs b/API/Controller/Shares/DeleteShareCode.cs index 2a91d5f2a..e14af033d 100644 --- a/API/Controller/Shares/DeleteShareCode.cs +++ b/API/Controller/Shares/DeleteShareCode.cs @@ -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 - [ApiVersion(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 151232280..9db601b35 100644 --- a/API/Controller/Shares/LinkShareCode.cs +++ b/API/Controller/Shares/LinkShareCode.cs @@ -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 - [ApiVersion(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 0ba22d537..a60fac59e 100644 --- a/API/Controller/Shares/Links/AddShocker.cs +++ b/API/Controller/Shares/Links/AddShocker.cs @@ -21,8 +21,8 @@ public sealed partial class ShareLinksController /// Successfully added shocker /// Public share or shocker does not exist /// Shocker already exists in public share - [ApiVersion(1)] [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 888bfd9b9..77018adb3 100644 --- a/API/Controller/Shares/Links/CreatePublicShare.cs +++ b/API/Controller/Shares/Links/CreatePublicShare.cs @@ -15,8 +15,8 @@ public sealed partial class ShareLinksController /// Create a new public share /// /// The created public share - [ApiVersion(1)] [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 bc970c1d5..330a68e22 100644 --- a/API/Controller/Shares/Links/DeletePublicShare.cs +++ b/API/Controller/Shares/Links/DeletePublicShare.cs @@ -20,8 +20,8 @@ public sealed partial class ShareLinksController /// /// Deleted public share /// Public share not found or does not belong to you - [ApiVersion(1)] [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 0a0c6acd3..594359468 100644 --- a/API/Controller/Shares/Links/EditShocker.cs +++ b/API/Controller/Shares/Links/EditShocker.cs @@ -22,10 +22,10 @@ public sealed partial class ShareLinksController /// Successfully updated shocker /// Public share or shocker does not exist /// Shocker does not exist in public share - [ApiVersion(1)] [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 14193ef70..e74f9345e 100644 --- a/API/Controller/Shares/Links/List.cs +++ b/API/Controller/Shares/Links/List.cs @@ -15,8 +15,8 @@ public sealed partial class ShareLinksController /// Get all public shares for the current user /// /// All public shares for the current user - [ApiVersion(1)] [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 786768339..2557115fb 100644 --- a/API/Controller/Shares/Links/PauseShocker.cs +++ b/API/Controller/Shares/Links/PauseShocker.cs @@ -24,10 +24,10 @@ public sealed partial class ShareLinksController /// Successfully updated paused state shocker /// Public share or shocker does not exist /// Shocker does not exist in public share - [ApiVersion(1)] [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 183f52f21..cb190867c 100644 --- a/API/Controller/Shares/Links/RemoveShocker.cs +++ b/API/Controller/Shares/Links/RemoveShocker.cs @@ -22,8 +22,8 @@ public sealed partial class ShareLinksController /// Successfully removed shocker /// Public share or shocker does not exist /// Shocker does not exist in public share - [ApiVersion(1)] [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 f3db36cf3..4a4d3914e 100644 --- a/API/Controller/Shares/UserShares/CreateShareInvite.cs +++ b/API/Controller/Shares/UserShares/CreateShareInvite.cs @@ -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 - [ApiVersion(2)] public async Task CreateShareInvite([FromBody] CreateShareRequest body, CancellationToken cancellationToken) { if (body.User == CurrentUser.Id) diff --git a/API/Controller/Shares/UserShares/Invites.cs b/API/Controller/Shares/UserShares/Invites.cs index 8f3b4f3b5..1dbd23396 100644 --- a/API/Controller/Shares/UserShares/Invites.cs +++ b/API/Controller/Shares/UserShares/Invites.cs @@ -60,8 +60,8 @@ file static class QueryHelper public sealed partial class UserSharesController { [HttpGet("invites/outgoing")] - [TokenPermission(PermissionType.Usershares_Edit)] [ApiVersion(2)] + [TokenPermission(PermissionType.Usershares_Edit)] public IAsyncEnumerable GetOutgoingInvitesList() { return _db.UserShareInvites @@ -71,8 +71,8 @@ public IAsyncEnumerable GetOutgoingInvitesList() } [HttpGet("invites/incoming")] - [TokenPermission(PermissionType.Usershares_Edit)] [ApiVersion(2)] + [TokenPermission(PermissionType.Usershares_Edit)] 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)] - [ApiVersion(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)] - [ApiVersion(2)] public async Task DenyIncomingInvite([FromRoute] Guid inviteId, CancellationToken cancellationToken) { var deletedShareRequest = await _db.UserShareInvites @@ -118,10 +118,10 @@ 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)] - [ApiVersion(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 9ed87619c..2ec5714d6 100644 --- a/API/Controller/Shares/UserShares/PauseShockerShares.cs +++ b/API/Controller/Shares/UserShares/PauseShockerShares.cs @@ -14,8 +14,8 @@ namespace OpenShock.API.Controller.Shares.UserShares; public sealed partial class UserSharesController { [HttpPost("{userId:guid}/shockers/pause")] - [TokenPermission(PermissionType.Usershares_Pause)] [ApiVersion(2)] + [TokenPermission(PermissionType.Usershares_Pause)] [ProducesResponseType(StatusCodes.Status200OK)] public async Task BulkPauseUserShareShockers( [FromRoute] Guid userId, diff --git a/API/Controller/Shares/UserShares/UpdateShockerShares.cs b/API/Controller/Shares/UserShares/UpdateShockerShares.cs index e9a1e1443..ebca03f3a 100644 --- a/API/Controller/Shares/UserShares/UpdateShockerShares.cs +++ b/API/Controller/Shares/UserShares/UpdateShockerShares.cs @@ -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 - [ApiVersion(2)] public async Task BulkUserShareShockersUpdate( [FromRoute] Guid userId, [FromBody] BulkUserShareShockersUpdateRequest body, diff --git a/API/Controller/Shockers/EditShocker.cs b/API/Controller/Shockers/EditShocker.cs index e0b14935f..563772991 100644 --- a/API/Controller/Shockers/EditShocker.cs +++ b/API/Controller/Shockers/EditShocker.cs @@ -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 - [ApiVersion(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 d862a995f..8dc9dcabd 100644 --- a/API/Controller/Shockers/GetShockerById.cs +++ b/API/Controller/Shockers/GetShockerById.cs @@ -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 - [ApiVersion(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 7805fd8fc..9236a3c2a 100644 --- a/API/Controller/Shockers/GetShockerLogs.cs +++ b/API/Controller/Shockers/GetShockerLogs.cs @@ -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 - [ApiVersion(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)] - [ApiVersion(1)] public async Task> GetAllShockerLogs( [FromQuery] PaginationQuery pagination, [FromQuery(Name = "shockerIds")] Guid[]? shockerIds, diff --git a/API/Controller/Shockers/PauseShocker.cs b/API/Controller/Shockers/PauseShocker.cs index 6c6605ece..a8d7ae1b4 100644 --- a/API/Controller/Shockers/PauseShocker.cs +++ b/API/Controller/Shockers/PauseShocker.cs @@ -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 - [ApiVersion(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 50fcddbae..4c22fd848 100644 --- a/API/Controller/Shockers/RegisterShocker.cs +++ b/API/Controller/Shockers/RegisterShocker.cs @@ -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 - [ApiVersion(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 d8aa94a4a..fd9861e1e 100644 --- a/API/Controller/Shockers/RemoveShocker.cs +++ b/API/Controller/Shockers/RemoveShocker.cs @@ -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 - [ApiVersion(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 a696674a3..2f6f03113 100644 --- a/API/Controller/Shockers/SendControl.cs +++ b/API/Controller/Shockers/SendControl.cs @@ -21,8 +21,8 @@ public sealed partial class ShockerController /// Send a control message to shockers /// /// The control messages were successfully sent. - [ApiVersion(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. - [ApiVersion(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 dab9bbaab..94c5e7b92 100644 --- a/API/Controller/Shockers/ShockerShares.cs +++ b/API/Controller/Shockers/ShockerShares.cs @@ -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 - [ApiVersion(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 - [ApiVersion(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); @@ -107,11 +107,11 @@ 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 - [ApiVersion(1)] public async Task ShockerShareCodeCreate( [FromRoute] Guid shockerId, [FromBody] ShockerPermLimitPair body, @@ -152,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 - [ApiVersion(1)] public async Task ShockerShareRemove( [FromRoute] Guid shockerId, [FromRoute] Guid sharedWithUserId, @@ -187,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 - [ApiVersion(1)] public async Task ShockerShareCodeUpdate( [FromRoute] Guid shockerId, [FromRoute] Guid sharedWithUserId, @@ -233,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 - [ApiVersion(1)] public async Task ShockerShareCodePause( [FromRoute] Guid shockerId, [FromRoute] Guid sharedWithUserId, diff --git a/API/Controller/Tokens/DeleteToken.cs b/API/Controller/Tokens/DeleteToken.cs index b73e5bb72..d78ba108d 100644 --- a/API/Controller/Tokens/DeleteToken.cs +++ b/API/Controller/Tokens/DeleteToken.cs @@ -35,8 +35,8 @@ public TokenDeleteController(IApiTokenService tokenService, ILoggerSuccessfully deleted token /// Api Token is not allowed to delete other Api Tokens /// The token does not exist, or you do not have access to it - [ApiVersion(1)] [HttpDelete("{tokenId}")] + [ApiVersion(1)] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status403Forbidden)] [ProducesResponseType(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // ApiTokenNotFound diff --git a/API/Controller/Tokens/ReportTokens.cs b/API/Controller/Tokens/ReportTokens.cs index 1c680e69e..6126cc2b1 100644 --- a/API/Controller/Tokens/ReportTokens.cs +++ b/API/Controller/Tokens/ReportTokens.cs @@ -29,10 +29,10 @@ 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)] - [ApiVersion(1)] public async Task ReportTokens( [FromBody] ReportTokensRequest body, [FromServices] ICloudflareTurnstileService turnstileService, diff --git a/API/Controller/Tokens/Tokens.cs b/API/Controller/Tokens/Tokens.cs index 2341c467a..af7981988 100644 --- a/API/Controller/Tokens/Tokens.cs +++ b/API/Controller/Tokens/Tokens.cs @@ -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 - [ApiVersion(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 - [ApiVersion(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)] - [ApiVersion(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 - [ApiVersion(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)] - [ApiVersion(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 - [ApiVersion(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 - [ApiVersion(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/Users/GetSelf.cs b/API/Controller/Users/GetSelf.cs index 54d81b551..5e3c3146b 100644 --- a/API/Controller/Users/GetSelf.cs +++ b/API/Controller/Users/GetSelf.cs @@ -14,8 +14,8 @@ public sealed partial class UsersController /// /// The user's information was successfully retrieved. [Obsolete("Use GET /1/account instead.")] - [ApiVersion(1)] [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 275f792fc..e664fd4d0 100644 --- a/API/Controller/Users/GetSelfControlStats.cs +++ b/API/Controller/Users/GetSelfControlStats.cs @@ -26,10 +26,10 @@ 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 - [ApiVersion(1)] public async Task GetSelfControlStats( [FromQuery, MaxLength(64)] string? tz, [FromQuery] DateOnly? from, diff --git a/API/Controller/Users/LookupByName.cs b/API/Controller/Users/LookupByName.cs index 1fffe0541..478ddc5bb 100644 --- a/API/Controller/Users/LookupByName.cs +++ b/API/Controller/Users/LookupByName.cs @@ -10,8 +10,8 @@ namespace OpenShock.API.Controller.Users; public sealed partial class UsersController { - [ApiVersion(1)] [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 91a74e2c1..93fde37aa 100644 --- a/API/Controller/Version/_ApiController.cs +++ b/API/Controller/Version/_ApiController.cs @@ -18,8 +18,8 @@ namespace OpenShock.API.Controller.Version; /// Version stuff /// [ApiController] -[Route("/{version:apiVersion}")] [Tags("Meta")] +[Route("/{version:apiVersion}")] public sealed partial class VersionController : OpenShockControllerBase { private static string GetBackendVersion() @@ -39,8 +39,8 @@ private static string GetBackendVersion() /// Gets the version of the OpenShock backend. /// /// The version was successfully retrieved. - [ApiVersion(1)] [HttpGet] + [ApiVersion(1)] [ProducesResponseType>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public async Task GetBackendInfo( [FromServices] IAuthenticationSchemeProvider schemeProvider, diff --git a/LiveControlGateway/Controllers/HubV1Controller.cs b/LiveControlGateway/Controllers/HubV1Controller.cs index 90ca64f21..8c22df818 100644 --- a/LiveControlGateway/Controllers/HubV1Controller.cs +++ b/LiveControlGateway/Controllers/HubV1Controller.cs @@ -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 7b1f735f1..87b7a1091 100644 --- a/LiveControlGateway/Controllers/HubV2Controller.cs +++ b/LiveControlGateway/Controllers/HubV2Controller.cs @@ -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 e334ee2e2..45b1ae759 100644 --- a/LiveControlGateway/Controllers/InstanceDetailsController.cs +++ b/LiveControlGateway/Controllers/InstanceDetailsController.cs @@ -24,8 +24,8 @@ public sealed class InstanceDetailsController : OpenShockControllerBase /// /// Instance details was successfully retrieved. [HttpGet] - [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] [ApiVersion(1)] + [ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Json)] public InstanceDetailsResponse GetNodeInfo([FromServices] LcgOptions options) { return new InstanceDetailsResponse diff --git a/LiveControlGateway/Controllers/LiveControlController.cs b/LiveControlGateway/Controllers/LiveControlController.cs index 562022119..5d3370d87 100644 --- a/LiveControlGateway/Controllers/LiveControlController.cs +++ b/LiveControlGateway/Controllers/LiveControlController.cs @@ -31,10 +31,10 @@ namespace OpenShock.LiveControlGateway.Controllers; /// Live control controller /// [ApiController] -[ApiVersion(1)] [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 { From 140c1ef65d7720ae904104910172feb6e325015a Mon Sep 17 00:00:00 2001 From: HeavenVR Date: Sun, 15 Nov 2026 13:55:53 +0100 Subject: [PATCH 7/8] fix: document the union of schemes for stacked [Authorize] attributes GET /1/account adds [Authorize(UserSessionCookie,ApiToken)] on top of its controller's [Authorize(UserSessionCookie)], which made the operation transformer throw and every OpenAPI document request return 500. ASP.NET combines stacked [Authorize] attributes into one policy accepting the union of their schemes, so document exactly that. --- Common/OpenApi/OpenShockOperationTransformer.cs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) 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(); From 77ebf807cd92ff902e3008cb1e95cb453e46691c Mon Sep 17 00:00:00 2001 From: HeavenVR Date: Sun, 15 Nov 2026 13:55:53 +0100 Subject: [PATCH 8/8] feat: serve the OpenAPI document at /openapi.json There is a single document now, so the {documentName} segment only repeated the host name. MapOpenApi serves the default document ("v1") on a route without that segment, so the document is registered under that name. --- .../Tests/OpenApiDocumentTests.cs | 27 +++++++++++++++++++ Common/OpenShockMiddlewareHelper.cs | 4 +-- Common/OpenShockServiceHelper.cs | 10 +++++-- 3 files changed, 37 insertions(+), 4 deletions(-) create mode 100644 API.IntegrationTests/Tests/OpenApiDocumentTests.cs 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/Common/OpenShockMiddlewareHelper.cs b/Common/OpenShockMiddlewareHelper.cs index 4c3213cc7..2eaefb271 100644 --- a/Common/OpenShockMiddlewareHelper.cs +++ b/Common/OpenShockMiddlewareHelper.cs @@ -131,11 +131,11 @@ exception is null return IsAllowed(context.Connection.RemoteIpAddress, internalAllowedIpNetworks); }); - app.MapOpenApi(); + app.MapOpenApi(OpenShockServiceHelper.OpenApiDocumentPath); app.MapScalarApiReference("/scalar/viewer", options => options - .WithOpenApiRoutePattern("/openapi/{documentName}.json") + .WithOpenApiRoutePattern(OpenShockServiceHelper.OpenApiDocumentPath) .AddDocument(OpenShockServiceHelper.OpenApiDocumentName, "OpenShock API") ); diff --git a/Common/OpenShockServiceHelper.cs b/Common/OpenShockServiceHelper.cs index 909d9c1b4..c488a8c4d 100644 --- a/Common/OpenShockServiceHelper.cs +++ b/Common/OpenShockServiceHelper.cs @@ -46,9 +46,15 @@ namespace OpenShock.Common; public static class OpenShockServiceHelper { /// - /// Name of the single OpenAPI document, served at /openapi/{name}.json. + /// 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 = "openshock"; + 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,