cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-21 12:06:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation comments for IGraphQLAuthorityInvoker params

Browse Source
This commit is contained in:
Jordan Dominion
2024-09-21 17:23:56 -04:00
parent 07a317ed81
commit 8139422fe8
7 changed files with 25 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Tgstation.Server.Host/GraphQL/Mutation.cs
+1 -1
View File
@@ -19,7 +19,7 @@ namespace Tgstation.Server.Host.GraphQL
/// <summary>
/// Generate a JWT for authenticating with server. This is the only operation that accepts and required basic authentication.
/// </summary>
/// <param name="loginAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="ILoginAuthority"/>.</param>
/// <param name="loginAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="ILoginAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>A Bearer token to be used with further communication with the server.</returns>
[Error(typeof(ErrorMessageException))]
src/Tgstation.Server.Host/GraphQL/Mutations/UserMutations.cs
+7 -7
View File
@@ -32,7 +32,7 @@ namespace Tgstation.Server.Host.GraphQL.Mutations
/// <param name="enabled">If the <see cref="User"/> is <see cref="User.Enabled"/>.</param>
/// <param name="oAuthConnections">The <see cref="OAuthConnection"/>s for the user.</param>
/// <param name="permissionSet">The owned <see cref="PermissionSet"/> of the user.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserAuthority"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>The created <see cref="User"/>.</returns>
[TgsGraphQLAuthorize<IUserAuthority>(nameof(IUserAuthority.Create))]
@@ -82,7 +82,7 @@ namespace Tgstation.Server.Host.GraphQL.Mutations
/// <param name="enabled">If the <see cref="User"/> is <see cref="User.Enabled"/>.</param>
/// <param name="oAuthConnections">The <see cref="OAuthConnection"/>s for the user.</param>
/// <param name="permissionSet">The owned <see cref="PermissionSet"/> of the user.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserAuthority"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>The created <see cref="User"/>.</returns>
[TgsGraphQLAuthorize<IUserAuthority>(nameof(IUserAuthority.Create))]
@@ -130,7 +130,7 @@ namespace Tgstation.Server.Host.GraphQL.Mutations
/// <param name="enabled">If the <see cref="User"/> is <see cref="User.Enabled"/>.</param>
/// <param name="oAuthConnections">The <see cref="OAuthConnection"/>s for the user.</param>
/// <param name="groupId">The <see cref="Entity.Id"/> of the <see cref="UserGroup"/> the <see cref="User"/> will belong to.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserAuthority"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>The created <see cref="User"/>.</returns>
[TgsGraphQLAuthorize<IUserAuthority>(nameof(IUserAuthority.Create))]
@@ -177,7 +177,7 @@ namespace Tgstation.Server.Host.GraphQL.Mutations
/// <param name="enabled">If the <see cref="User"/> is <see cref="User.Enabled"/>.</param>
/// <param name="oAuthConnections">The <see cref="OAuthConnection"/>s for the user.</param>
/// <param name="groupId">The <see cref="Entity.Id"/> of the <see cref="UserGroup"/> the <see cref="User"/> will belong to.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserAuthority"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>The created <see cref="User"/>.</returns>
[TgsGraphQLAuthorize<IUserAuthority>(nameof(IUserAuthority.Create))]
@@ -219,7 +219,7 @@ namespace Tgstation.Server.Host.GraphQL.Mutations
/// </summary>
/// <param name="newPassword">The new password for the current user.</param>
/// <param name="authenticationContext">The <see cref="IAuthenticationContext"/> to get the <see cref="Entity.Id"/> of the user.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserAuthority"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>The updated current <see cref="User"/>.</returns>
[TgsGraphQLAuthorize(AdministrationRights.WriteUsers | AdministrationRights.EditOwnPassword)]
@@ -247,7 +247,7 @@ namespace Tgstation.Server.Host.GraphQL.Mutations
/// </summary>
/// <param name="newOAuthConnections">The new <see cref="OAuthConnection"/>s for the current user.</param>
/// <param name="authenticationContext">The <see cref="IAuthenticationContext"/> to get the <see cref="Entity.Id"/> of the user.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserAuthority"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>The updated current <see cref="User"/>.</returns>
[TgsGraphQLAuthorize(AdministrationRights.WriteUsers | AdministrationRights.EditOwnOAuthConnections)]
@@ -286,7 +286,7 @@ namespace Tgstation.Server.Host.GraphQL.Mutations
/// <param name="newPermissionSet">Optional new owned <see cref="PermissionSet"/> for the user.</param>
/// <param name="newGroupId">Optional <see cref="Entity.Id"/> of the <see cref="UserGroup"/> to move the <see cref="User"/> to.</param>
/// <param name="newOAuthConnections">Optional new <see cref="OAuthConnection"/>s for the <see cref="User"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserAuthority"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>The updated <see cref="User"/>.</returns>
[TgsGraphQLAuthorize(AdministrationRights.WriteUsers)]
src/Tgstation.Server.Host/GraphQL/Types/User.cs
+6 -6
View File
@@ -54,7 +54,7 @@ namespace Tgstation.Server.Host.GraphQL.Types
/// Node resolver for <see cref="User"/>s.
/// </summary>
/// <param name="id">The <see cref="Entity.Id"/> to lookup.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserAuthority"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>A <see cref="ValueTask"/> resulting in the queried <see cref="User"/>, if present.</returns>
[TgsGraphQLAuthorize]
@@ -71,7 +71,7 @@ namespace Tgstation.Server.Host.GraphQL.Types
/// <summary>
/// The <see cref="User"/> who created this <see cref="User"/>.
/// </summary>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserAuthority"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>The <see cref="IUserName"/> that created this <see cref="User"/>, if any.</returns>
public async ValueTask<IUserName?> CreatedBy(
@@ -92,7 +92,7 @@ namespace Tgstation.Server.Host.GraphQL.Types
/// <summary>
/// List of <see cref="OAuthConnection"/>s associated with the user if OAuth is configured.
/// </summary>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserAuthority"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>A <see cref="ValueTask{TResult}"/> resulting in a new <see cref="Array"/> of <see cref="OAuthConnection"/>s for the <see cref="User"/> if OAuth is configured.</returns>
public ValueTask<OAuthConnection[]> OAuthConnections(
@@ -107,7 +107,7 @@ namespace Tgstation.Server.Host.GraphQL.Types
/// <summary>
/// The <see cref="PermissionSet"/> associated with the <see cref="User"/>.
/// </summary>
/// <param name="permissionSetAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IPermissionSetAuthority"/>.</param>
/// <param name="permissionSetAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IPermissionSetAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>A <see cref="ValueTask{TResult}"/> resulting in the <see cref="PermissionSet"/> associated with the <see cref="User"/>.</returns>
public ValueTask<PermissionSet> EffectivePermissionSet(
@@ -136,7 +136,7 @@ namespace Tgstation.Server.Host.GraphQL.Types
/// <summary>
/// The <see cref="PermissionSet"/> owned by the <see cref="User"/>, if any.
/// </summary>
/// <param name="permissionSetAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IPermissionSetAuthority"/>.</param>
/// <param name="permissionSetAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IPermissionSetAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>A <see cref="ValueTask{TResult}"/> resulting in the <see cref="PermissionSet"/> owned by the <see cref="User"/>, if any.</returns>
public ValueTask<PermissionSet?> OwnedPermissionSet(
@@ -152,7 +152,7 @@ namespace Tgstation.Server.Host.GraphQL.Types
/// <summary>
/// The <see cref="UserGroup"/> asociated with the user, if any.
/// </summary>
/// <param name="userGroupAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserGroupAuthority"/>.</param>
/// <param name="userGroupAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserGroupAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>A <see cref="ValueTask{TResult}"/> resulting in the <see cref="UserGroup"/> associated with the <see cref="User"/>, if any.</returns>
public async ValueTask<UserGroup?> Group(
src/Tgstation.Server.Host/GraphQL/Types/UserGroup.cs
+3 -3
View File
@@ -24,7 +24,7 @@ namespace Tgstation.Server.Host.GraphQL.Types
/// Node resolver for <see cref="User"/>s.
/// </summary>
/// <param name="id">The <see cref="Entity.Id"/> to lookup.</param>
/// <param name="userGroupAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserGroupAuthority"/>.</param>
/// <param name="userGroupAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserGroupAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>A <see cref="ValueTask"/> resulting in the queried <see cref="User"/>, if present.</returns>
[TgsGraphQLAuthorize]
@@ -41,7 +41,7 @@ namespace Tgstation.Server.Host.GraphQL.Types
/// <summary>
/// The <see cref="PermissionSet"/> owned by the <see cref="UserGroup"/>.
/// </summary>
/// <param name="permissionSetAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IPermissionSetAuthority"/>.</param>
/// <param name="permissionSetAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IPermissionSetAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>A <see cref="ValueTask{TResult}"/> resulting in the <see cref="PermissionSet"/> owned by the <see cref="UserGroup"/>.</returns>
public async ValueTask<PermissionSet> PermissionSet(
@@ -57,7 +57,7 @@ namespace Tgstation.Server.Host.GraphQL.Types
/// <summary>
/// Queries all registered <see cref="User"/>s in the <see cref="UserGroup"/>.
/// </summary>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserAuthority"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserAuthority"/>.</param>
/// <returns>A <see cref="IQueryable{T}"/> of all registered <see cref="User"/>s in the <see cref="UserGroup"/>.</returns>
[UsePaging]
[UseFiltering]
src/Tgstation.Server.Host/GraphQL/Types/UserGroups.cs
+4 -4
View File
@@ -22,7 +22,7 @@ namespace Tgstation.Server.Host.GraphQL.Types
/// <summary>
/// Gets the current <see cref="User"/>.
/// </summary>
/// <param name="userGroupAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserGroupAuthority"/>.</param>
/// <param name="userGroupAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserGroupAuthority"/>.</param>
/// <returns>A <see cref="ValueTask{TResult}"/> resulting in the current <see cref="User"/>'s <see cref="UserGroup"/>.</returns>
public ValueTask<UserGroup?> Current(
[Service] IGraphQLAuthorityInvoker<IUserGroupAuthority> userGroupAuthority)
@@ -35,7 +35,7 @@ namespace Tgstation.Server.Host.GraphQL.Types
/// Gets a <see cref="UserGroup"/> by <see cref="Entity.Id"/>.
/// </summary>
/// <param name="id">The <see cref="Entity.Id"/> of the <see cref="User"/>.</param>
/// <param name="userGroupAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserGroupAuthority"/>.</param>
/// <param name="userGroupAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserGroupAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>The <see cref="UserGroup"/> represented by <paramref name="id"/>, if any.</returns>
[TgsGraphQLAuthorize<IUserAuthority>(nameof(IUserGroupAuthority.GetId))]
@@ -48,7 +48,7 @@ namespace Tgstation.Server.Host.GraphQL.Types
/// <summary>
/// Queries all registered <see cref="UserGroup"/>s.
/// </summary>
/// <param name="userGroupAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserGroupAuthority"/>.</param>
/// <param name="userGroupAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserGroupAuthority"/>.</param>
/// <returns>A <see cref="IQueryable{T}"/> of all registered <see cref="UserGroup"/>s.</returns>
[UsePaging]
[UseFiltering]
@@ -66,7 +66,7 @@ namespace Tgstation.Server.Host.GraphQL.Types
/// Queries all registered <see cref="User"/>s in a <see cref="UserGroup"/> indicated by <paramref name="groupId"/>.
/// </summary>
/// <param name="groupId">The <see cref="UserGroup"/> <see cref="Entity.Id"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserAuthority"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserAuthority"/>.</param>
/// <returns>A <see cref="IQueryable{T}"/> of all registered <see cref="User"/>s in the <see cref="UserGroup"/> indicated by <paramref name="groupId"/>.</returns>
[UsePaging]
[UseFiltering]
src/Tgstation.Server.Host/GraphQL/Types/UserName.cs
+1 -1
View File
@@ -23,7 +23,7 @@ namespace Tgstation.Server.Host.GraphQL.Types
/// Node resolver for <see cref="UserName"/>s.
/// </summary>
/// <param name="id">The <see cref="Entity.Id"/> to lookup.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserAuthority"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>A <see cref="ValueTask"/> resulting in the queried <see cref="UserName"/>, if present.</returns>
[TgsGraphQLAuthorize]
src/Tgstation.Server.Host/GraphQL/Types/Users.cs
+3 -3
View File
@@ -30,7 +30,7 @@ namespace Tgstation.Server.Host.GraphQL.Types
/// <summary>
/// Gets the current <see cref="User"/>.
/// </summary>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserAuthority"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>A <see cref="ValueTask{TResult}"/> resulting in the current <see cref="User"/>.</returns>
[TgsGraphQLAuthorize<IUserAuthority>(nameof(IUserAuthority.Read))]
@@ -46,7 +46,7 @@ namespace Tgstation.Server.Host.GraphQL.Types
/// Gets a <see cref="User"/> by <see cref="Entity.Id"/>.
/// </summary>
/// <param name="id">The <see cref="Entity.Id"/> of the <see cref="User"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserAuthority"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserAuthority"/>.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>The <see cref="User"/> represented by <paramref name="id"/>, if any.</returns>
[Error(typeof(ErrorMessageException))]
@@ -60,7 +60,7 @@ namespace Tgstation.Server.Host.GraphQL.Types
/// <summary>
/// Queries all registered <see cref="User"/>s.
/// </summary>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> <see cref="IUserAuthority"/>.</param>
/// <param name="userAuthority">The <see cref="IGraphQLAuthorityInvoker{TAuthority}"/> for the <see cref="IUserAuthority"/>.</param>
/// <returns>A <see cref="IQueryable{T}"/> of all registered <see cref="User"/>s.</returns>
[UsePaging]
[UseFiltering]