From ede5b68b74f8b5ae0b1cded38e418c7bf2532330 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CNaeel=E2=80=9D?= Date: Sat, 1 Aug 2026 19:19:17 +0400 Subject: [PATCH] =?UTF-8?q?doc:=20=D1=82=D1=80=D0=B8=20=D0=B4=D0=BE=D0=BF?= =?UTF-8?q?=D0=BE=D0=BB=D0=BD=D0=B8=D1=82=D0=B5=D0=BB=D1=8C=D0=BD=D1=8B?= =?UTF-8?q?=D1=85=20=D0=B2=D0=BE=D0=BF=D1=80=D0=BE=D1=81=D0=B0=20=D0=A1?= =?UTF-8?q?=D0=BE=D0=BD=D0=BD=D0=B5=D1=82=D1=83=20=E2=80=94=20requestInter?= =?UTF-8?q?ceptor,=20docExpansion,=20examples?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- polygon-docs/sonnet-swagger-review-prompt.md | 27 ++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/polygon-docs/sonnet-swagger-review-prompt.md b/polygon-docs/sonnet-swagger-review-prompt.md index a65b34c..372c248 100644 --- a/polygon-docs/sonnet-swagger-review-prompt.md +++ b/polygon-docs/sonnet-swagger-review-prompt.md @@ -54,6 +54,33 @@ - Не усложнять — полигон это мок, не прод - Не предлагать автогенерацию из кода через декораторы +## Дополнительные вопросы + +### requestInterceptor и X-Mock-Auth + +Сейчас `swagger.html` добавляет только `Authorization: Bearer` через `requestInterceptor`. +Но `_mock/*` эндпоинты проверяют заголовок `X-Mock-Auth`, а не `Authorization`. +Как правильно дописать `requestInterceptor` чтобы оба механизма работали: +- `Authorization: Bearer ` — для всех эндпоинтов (если включена глобальная auth) +- `X-Mock-Auth: ` — только для `_mock/*` + +### docExpansion + +Какое значение `docExpansion` оптимально для Swagger UI 5? +- `"list"` — раскрыты только названия тегов (средний вариант) +- `"none"` — всё свёрнуто (минимализм) +- `"full"` — все эндпоинты раскрыты (но может быть перегружено) + +Учитывая что есть 5 тегов (services, instances, operations, health, mock) и ~17 эндпоинтов. + +### Примеры ответов (examples) + +В каких схемах стоит добавить `example` чтобы Try it out был максимально полезен? +Например: +- `Instance` с реальными данными (instanceUid, serviceId, status, state.params, state.out) +- `CfsParam` с valueList (чтобы было видно как выглядят enum-параметры) +- `Operation` до run (dtStart=null, dtFinish=null) и после run (всё заполнено) + ## Формат ответа Сгруппируй находки так: