Почистить комментарии от упоминаний процесса
Удалены <remarks>, <summary> сжаты до короткой фразы, вырезаны ссылки на Task/Ruling/этап/python/прототип; //-комментарии со ссылками на процесс удалены; то же в .proto. Правила обновлены в docs/spec/Код-стайл-Дейл.md. Строк комментариев 27210 -> ~19100.
This commit is contained in:
@@ -6,37 +6,23 @@ using Deal.Api.Services;
|
||||
namespace Deal.Api.Endpoints;
|
||||
|
||||
/// <summary>
|
||||
/// SSE-поток событий канбана: GET /api/events (Ruling 5; прототип events_routes.py L15–38).
|
||||
/// SSE-поток событий канбана
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Открывает <c>text/event-stream</c> с подпиской на канал тенанта сессии (singleton SseBroker).
|
||||
/// События пишутся по мере поступления; при тишине 15 с отправляется ping-комментарий ": ping" —
|
||||
/// соединение держится (переподключение EventSource, api.js L62–104). Завершение — по отвалу клиента
|
||||
/// (CancellationToken = RequestAborted); отписка — в finally. Без сессии — 401 {detail} (Ruling 10,
|
||||
/// паттерн остальных эндпоинтов). Заголовки: Content-Type text/event-stream, Cache-Control: no-cache,
|
||||
/// X-Accel-Buffering: no (запрет буферизации прокси, иначе ping/события задерживаются).
|
||||
/// </remarks>
|
||||
public static class EventsEndpoint
|
||||
{
|
||||
// Путь потока (роутер events, events_routes.py L12: prefix="/api").
|
||||
private const string EventsPath = "/api/events";
|
||||
|
||||
// OpenAPI-тег группы (в прототипе — роутер events_routes.py).
|
||||
private const string OpenApiTag = "events";
|
||||
|
||||
// Тип контента потока (events_routes.py L32).
|
||||
private const string EventStreamContentType = "text/event-stream";
|
||||
|
||||
// Директива кеширования: поток не кешируется (events_routes.py L34).
|
||||
private const string NoCacheHeaderValue = "no-cache";
|
||||
|
||||
// Отключение буферизации ответа nginx-прокси (events_routes.py L35).
|
||||
private const string NoBufferingHeaderValue = "no";
|
||||
|
||||
// Ping-комментарий: строки протокола SSE, начинающиеся с ':', клиент игнорирует.
|
||||
private const string PingComment = ": ping\n\n";
|
||||
|
||||
// Интервал ping при тишине: держим соединение (events_routes.py L24: timeout=15).
|
||||
private static readonly TimeSpan PingInterval = TimeSpan.FromSeconds(15);
|
||||
|
||||
/// <summary>
|
||||
|
||||
Reference in New Issue
Block a user