mirror of
https://github.com/bitwarden/server
synced 2025-12-20 02:03:46 +00:00
Add documentation
This commit is contained in:
@@ -3,6 +3,14 @@ using Bit.SeederApi.Models.Response;
|
||||
|
||||
namespace Bit.SeederApi.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Service for executing and managing scene operations.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The scene service provides a mechanism to execute scene operations by name with optional JSON arguments.
|
||||
/// Scenes create and configure test data, track entities for cleanup, and support destruction of seeded data.
|
||||
/// Each scene execution can be assigned a play ID for tracking and subsequent cleanup operations.
|
||||
/// </remarks>
|
||||
public interface ISceneService
|
||||
{
|
||||
/// <summary>
|
||||
@@ -22,5 +30,10 @@ public interface ISceneService
|
||||
/// <returns>The result of the destroy operation</returns>
|
||||
/// <exception cref="SceneExecutionException">Thrown when there's an error destroying the seeded data</exception>
|
||||
Task<object?> DestroyScene(string playId);
|
||||
|
||||
/// <summary>
|
||||
/// Retrieves all play IDs for currently tracked seeded data.
|
||||
/// </summary>
|
||||
/// <returns>A list of play IDs representing active seeded data that can be destroyed.</returns>
|
||||
List<string> GetAllPlayIds();
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user