using SchotzIadKmTracker.Api.Models.DTOs;

namespace SchotzIadKmTracker.Api.Services;

/// <summary>
/// Fournit l'accès en lecture seule aux documents de spécification du projet
/// (requirements, design, tasks) pour affichage dans le frontend.
/// </summary>
public interface ISpecDocumentService
{
    /// <summary>Liste les documents de spécification connus et leur disponibilité.</summary>
    IReadOnlyList<SpecDocumentDto> Lister();

    /// <summary>
    /// Retourne le contenu Markdown du document identifié par <paramref name="cle"/>,
    /// ou <c>null</c> si la clé est inconnue (hors whitelist) ou le fichier absent.
    /// </summary>
    Task<SpecContenuDto?> ObtenirAsync(string cle, CancellationToken cancellationToken = default);
}