Skip to content

Commit

Permalink
Use proper C# doc comments for CanSyncProject
Browse files Browse the repository at this point in the history
  • Loading branch information
rmunn committed Jul 8, 2024
1 parent 44bc659 commit 3fe6cf5
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions backend/LexCore/ServiceInterfaces/IPermissionService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,15 @@ namespace LexCore.ServiceInterfaces;
public interface IPermissionService
{
ValueTask<bool> CanSyncProject(string projectCode);
// CanSyncProject(Guid) does NOT check permissions for org managers, because that requires async DB access
/// <summary>
/// Does NOT check permissions for org managers, because that requires async DB access.
/// Use CanSyncProject(projectCode) or CanSyncProjectAsync(projectId) if org manager permissions also need to be checked.
/// </summary>
bool CanSyncProject(Guid projectId);
// CanSyncProjectAsync(Guid) does all the checks from CanSyncProject, plus allows org managers to access the org as well
// CanSyncProjectAsync(Guid) does
/// <summary>
/// Does all the checks from CanSyncProject, plus allows org managers to access the org as well.
/// </summary>
ValueTask<bool> CanSyncProjectAsync(Guid projectId);
ValueTask AssertCanSyncProject(string projectCode);
ValueTask AssertCanSyncProject(Guid projectId);
Expand Down

0 comments on commit 3fe6cf5

Please sign in to comment.