Skip to content

refactor!: extract Scalar presentation from HTTP - #26

Merged
PANiXiDA merged 11 commits into
mainfrom
feature/api-documentation
Nov 11, 2026
Merged

PANiXiDA merged 11 commits into
mainfrom
feature/api-documentation

Conversation

@PANiXiDA

@PANiXiDA PANiXiDA commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Изменения

  • HTTP сохраняет OpenAPI, модульность, версии и общий источник дескрипторов.
  • Scalar UI, его трансформеры, favicon и JS-сортировка вынесены в Presentation.Scalar. HTTP и его тесты собираются без Scalar.
  • Microsoft.AspNetCore.OpenApi обновлён до 10.0.14; major версия пакета — 6.0.
  • HTTP проверяет JSON OpenAPI и каталог документов напрямую. Сценарии сортировки перенесены в test: cover Scalar sorting scenarios presentation-scalar#2.
  • Внутренние настройки OpenAPI и валидатор перенесены в Options/OpenApi под именами OpenApiOptions и OpenApiOptionsValidator.

Проверка

Локально прошли dotnet restore, dotnet format, dotnet build -c Release и dotnet test -c Release с ApiDocumentation 1.0.2 из NuGet. Прошли 425 тестов, включая сценарии Enabled, модульности, версионирования и static assets.

CI прошёл с покрытием строк и веток 100%. Sonar Quality Gate пройден.

Breaking change и зависимости

Host должен подключить PANiXiDA.Core.Presentation.Scalar, вызвать AddApiDocumentation(configuration) и UseApiDocumentation() после UseHttp(). Ключ ScalarConfiguration сохранён, Enabled позволяет явно изменить доступность документации по окружениям. Миграций нет; маршруты OpenAPI сохранены.
Для ApiDocumentation в Directory.Packages.props указана версия 1.0.2.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-11T09:48:45.058491Z e0d5a5a Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@panixida-sonarqube

Copy link
Copy Markdown

@PANiXiDA

Copy link
Copy Markdown
Contributor Author

@codex

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Another round soon, please!

Reviewed commit: e0d5a5aed0

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@PANiXiDA
PANiXiDA merged commit 46a7cf9 into main Nov 11, 2026
8 checks passed
@PANiXiDA
PANiXiDA deleted the feature/api-documentation branch November 11, 2026 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants