Files
parr_api/PARR.Core/Services/HelpDocument/Interfaces/IHelpDocumentService.cs

25 lines
1000 B
C#
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
using PARR.Domain.DTOs.HelpDocument;
namespace PARR.Core.Services.HelpDocument.Interfaces
{
/// <summary>
/// Сервис загрузки справочной документации
/// </summary>
public interface IHelpDocumentService
{
/// <summary>
/// Получить документ справки по его уникальному идентификатору (с учетом кэширования в Redis)
/// </summary>
/// <param name="helpId">Уникальный путь справке</param>
/// <returns></returns>
Task<HelpDocumentResult?> GetHelpDocumentAsync(string helpId);
/// <summary>
/// Сбрасывает кэш в Redis для конкретного документа справки (вызывается вебхуком)
/// </summary>
/// <param name="helpId"></param>
/// <returns></returns>
Task ClearCacheAsync(string helpId);
}
}