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);
    }
}