Browse Source

Some more docs

arch/seeder-api
Hinton 1 day ago
parent
commit
43cf41657c
No known key found for this signature in database
GPG Key ID: 5F7295599C5D965C
  1. 7
      src/Core/Services/IPlayDataService.cs
  2. 3
      util/Seeder/MangleId.cs
  3. 6
      util/Seeder/RecipeResult.cs

7
src/Core/Services/IPlayDataService.cs

@ -3,11 +3,14 @@ using Bit.Core.Entities; @@ -3,11 +3,14 @@ using Bit.Core.Entities;
namespace Bit.Core.Services;
/// <summary>
/// Service used to track added users and organizations during a Play session.
/// </summary>
public interface IPlayDataService
{
/// <summary>
/// Records a PlayData entry for the given User created during a Play session.
///
///
/// Does nothing if no Play Id is set for this http scope.
/// </summary>
/// <param name="user"></param>
@ -15,7 +18,7 @@ public interface IPlayDataService @@ -15,7 +18,7 @@ public interface IPlayDataService
Task Record(User user);
/// <summary>
/// Records a PlayData entry for the given Organization created during a Play session.
///
///
/// Does nothing if no Play Id is set for this http scope.
/// </summary>
/// <param name="organization"></param>

3
util/Seeder/MangleId.cs

@ -1,5 +1,8 @@ @@ -1,5 +1,8 @@
namespace Bit.Seeder;
/// <summary>
/// Helper for mangling IDs
/// </summary>
public class MangleId
{
public readonly string Value;

6
util/Seeder/RecipeResult.cs

@ -1,6 +0,0 @@ @@ -1,6 +0,0 @@
namespace Bit.Seeder;
public class RecipeResult
{
public Dictionary<string, List<Guid>> TrackedEntities { get; init; } = new();
}
Loading…
Cancel
Save