From 8139422fe8829edf9e3d9783fc46b67775169ef1 Mon Sep 17 00:00:00 2001 From: Jordan Dominion Date: Sat, 21 Sep 2024 17:23:56 -0400 Subject: [PATCH] Fix documentation comments for `IGraphQLAuthorityInvoker` params --- src/Tgstation.Server.Host/GraphQL/Mutation.cs | 2 +- .../GraphQL/Mutations/UserMutations.cs | 14 +++++++------- src/Tgstation.Server.Host/GraphQL/Types/User.cs | 12 ++++++------ .../GraphQL/Types/UserGroup.cs | 6 +++--- .../GraphQL/Types/UserGroups.cs | 8 ++++---- .../GraphQL/Types/UserName.cs | 2 +- src/Tgstation.Server.Host/GraphQL/Types/Users.cs | 6 +++--- 7 files changed, 25 insertions(+), 25 deletions(-) diff --git a/src/Tgstation.Server.Host/GraphQL/Mutation.cs b/src/Tgstation.Server.Host/GraphQL/Mutation.cs index 0e1bba29d9..4b68aa9b89 100644 --- a/src/Tgstation.Server.Host/GraphQL/Mutation.cs +++ b/src/Tgstation.Server.Host/GraphQL/Mutation.cs @@ -19,7 +19,7 @@ namespace Tgstation.Server.Host.GraphQL /// /// Generate a JWT for authenticating with server. This is the only operation that accepts and required basic authentication. /// - /// The . + /// The for the . /// The for the operation. /// A Bearer token to be used with further communication with the server. [Error(typeof(ErrorMessageException))] diff --git a/src/Tgstation.Server.Host/GraphQL/Mutations/UserMutations.cs b/src/Tgstation.Server.Host/GraphQL/Mutations/UserMutations.cs index 91cf35a3d4..bb19506d0d 100644 --- a/src/Tgstation.Server.Host/GraphQL/Mutations/UserMutations.cs +++ b/src/Tgstation.Server.Host/GraphQL/Mutations/UserMutations.cs @@ -32,7 +32,7 @@ namespace Tgstation.Server.Host.GraphQL.Mutations /// If the is . /// The s for the user. /// The owned of the user. - /// The . + /// The for the . /// The for the operation. /// The created . [TgsGraphQLAuthorize(nameof(IUserAuthority.Create))] @@ -82,7 +82,7 @@ namespace Tgstation.Server.Host.GraphQL.Mutations /// If the is . /// The s for the user. /// The owned of the user. - /// The . + /// The for the . /// The for the operation. /// The created . [TgsGraphQLAuthorize(nameof(IUserAuthority.Create))] @@ -130,7 +130,7 @@ namespace Tgstation.Server.Host.GraphQL.Mutations /// If the is . /// The s for the user. /// The of the the will belong to. - /// The . + /// The for the . /// The for the operation. /// The created . [TgsGraphQLAuthorize(nameof(IUserAuthority.Create))] @@ -177,7 +177,7 @@ namespace Tgstation.Server.Host.GraphQL.Mutations /// If the is . /// The s for the user. /// The of the the will belong to. - /// The . + /// The for the . /// The for the operation. /// The created . [TgsGraphQLAuthorize(nameof(IUserAuthority.Create))] @@ -219,7 +219,7 @@ namespace Tgstation.Server.Host.GraphQL.Mutations /// /// The new password for the current user. /// The to get the of the user. - /// The . + /// The for the . /// The for the operation. /// The updated current . [TgsGraphQLAuthorize(AdministrationRights.WriteUsers | AdministrationRights.EditOwnPassword)] @@ -247,7 +247,7 @@ namespace Tgstation.Server.Host.GraphQL.Mutations /// /// The new s for the current user. /// The to get the of the user. - /// The . + /// The for the . /// The for the operation. /// The updated current . [TgsGraphQLAuthorize(AdministrationRights.WriteUsers | AdministrationRights.EditOwnOAuthConnections)] @@ -286,7 +286,7 @@ namespace Tgstation.Server.Host.GraphQL.Mutations /// Optional new owned for the user. /// Optional of the to move the to. /// Optional new s for the . - /// The . + /// The for the . /// The for the operation. /// The updated . [TgsGraphQLAuthorize(AdministrationRights.WriteUsers)] diff --git a/src/Tgstation.Server.Host/GraphQL/Types/User.cs b/src/Tgstation.Server.Host/GraphQL/Types/User.cs index f47a3fb784..7e993fd358 100644 --- a/src/Tgstation.Server.Host/GraphQL/Types/User.cs +++ b/src/Tgstation.Server.Host/GraphQL/Types/User.cs @@ -54,7 +54,7 @@ namespace Tgstation.Server.Host.GraphQL.Types /// Node resolver for s. /// /// The to lookup. - /// The . + /// The for the . /// The for the operation. /// A resulting in the queried , if present. [TgsGraphQLAuthorize] @@ -71,7 +71,7 @@ namespace Tgstation.Server.Host.GraphQL.Types /// /// The who created this . /// - /// The . + /// The for the . /// The for the operation. /// The that created this , if any. public async ValueTask CreatedBy( @@ -92,7 +92,7 @@ namespace Tgstation.Server.Host.GraphQL.Types /// /// List of s associated with the user if OAuth is configured. /// - /// The . + /// The for the . /// The for the operation. /// A resulting in a new of s for the if OAuth is configured. public ValueTask OAuthConnections( @@ -107,7 +107,7 @@ namespace Tgstation.Server.Host.GraphQL.Types /// /// The associated with the . /// - /// The . + /// The for the . /// The for the operation. /// A resulting in the associated with the . public ValueTask EffectivePermissionSet( @@ -136,7 +136,7 @@ namespace Tgstation.Server.Host.GraphQL.Types /// /// The owned by the , if any. /// - /// The . + /// The for the . /// The for the operation. /// A resulting in the owned by the , if any. public ValueTask OwnedPermissionSet( @@ -152,7 +152,7 @@ namespace Tgstation.Server.Host.GraphQL.Types /// /// The asociated with the user, if any. /// - /// The . + /// The for the . /// The for the operation. /// A resulting in the associated with the , if any. public async ValueTask Group( diff --git a/src/Tgstation.Server.Host/GraphQL/Types/UserGroup.cs b/src/Tgstation.Server.Host/GraphQL/Types/UserGroup.cs index e8cd9cc855..2511ab438a 100644 --- a/src/Tgstation.Server.Host/GraphQL/Types/UserGroup.cs +++ b/src/Tgstation.Server.Host/GraphQL/Types/UserGroup.cs @@ -24,7 +24,7 @@ namespace Tgstation.Server.Host.GraphQL.Types /// Node resolver for s. /// /// The to lookup. - /// The . + /// The for the . /// The for the operation. /// A resulting in the queried , if present. [TgsGraphQLAuthorize] @@ -41,7 +41,7 @@ namespace Tgstation.Server.Host.GraphQL.Types /// /// The owned by the . /// - /// The . + /// The for the . /// The for the operation. /// A resulting in the owned by the . public async ValueTask PermissionSet( @@ -57,7 +57,7 @@ namespace Tgstation.Server.Host.GraphQL.Types /// /// Queries all registered s in the . /// - /// The . + /// The for the . /// A of all registered s in the . [UsePaging] [UseFiltering] diff --git a/src/Tgstation.Server.Host/GraphQL/Types/UserGroups.cs b/src/Tgstation.Server.Host/GraphQL/Types/UserGroups.cs index 51240221c8..eb9fc04a52 100644 --- a/src/Tgstation.Server.Host/GraphQL/Types/UserGroups.cs +++ b/src/Tgstation.Server.Host/GraphQL/Types/UserGroups.cs @@ -22,7 +22,7 @@ namespace Tgstation.Server.Host.GraphQL.Types /// /// Gets the current . /// - /// The . + /// The for the . /// A resulting in the current 's . public ValueTask Current( [Service] IGraphQLAuthorityInvoker userGroupAuthority) @@ -35,7 +35,7 @@ namespace Tgstation.Server.Host.GraphQL.Types /// Gets a by . /// /// The of the . - /// The . + /// The for the . /// The for the operation. /// The represented by , if any. [TgsGraphQLAuthorize(nameof(IUserGroupAuthority.GetId))] @@ -48,7 +48,7 @@ namespace Tgstation.Server.Host.GraphQL.Types /// /// Queries all registered s. /// - /// The . + /// The for the . /// A of all registered s. [UsePaging] [UseFiltering] @@ -66,7 +66,7 @@ namespace Tgstation.Server.Host.GraphQL.Types /// Queries all registered s in a indicated by . /// /// The . - /// The . + /// The for the . /// A of all registered s in the indicated by . [UsePaging] [UseFiltering] diff --git a/src/Tgstation.Server.Host/GraphQL/Types/UserName.cs b/src/Tgstation.Server.Host/GraphQL/Types/UserName.cs index 016a1bb2f4..7175c2935e 100644 --- a/src/Tgstation.Server.Host/GraphQL/Types/UserName.cs +++ b/src/Tgstation.Server.Host/GraphQL/Types/UserName.cs @@ -23,7 +23,7 @@ namespace Tgstation.Server.Host.GraphQL.Types /// Node resolver for s. /// /// The to lookup. - /// The . + /// The for the . /// The for the operation. /// A resulting in the queried , if present. [TgsGraphQLAuthorize] diff --git a/src/Tgstation.Server.Host/GraphQL/Types/Users.cs b/src/Tgstation.Server.Host/GraphQL/Types/Users.cs index d93f4ceec8..04ac751b25 100644 --- a/src/Tgstation.Server.Host/GraphQL/Types/Users.cs +++ b/src/Tgstation.Server.Host/GraphQL/Types/Users.cs @@ -30,7 +30,7 @@ namespace Tgstation.Server.Host.GraphQL.Types /// /// Gets the current . /// - /// The . + /// The for the . /// The for the operation. /// A resulting in the current . [TgsGraphQLAuthorize(nameof(IUserAuthority.Read))] @@ -46,7 +46,7 @@ namespace Tgstation.Server.Host.GraphQL.Types /// Gets a by . /// /// The of the . - /// The . + /// The for the . /// The for the operation. /// The represented by , if any. [Error(typeof(ErrorMessageException))] @@ -60,7 +60,7 @@ namespace Tgstation.Server.Host.GraphQL.Types /// /// Queries all registered s. /// - /// The . + /// The for the . /// A of all registered s. [UsePaging] [UseFiltering]