Skip to content

feat: add shared API documentation contracts and AsyncAPI generation - #1

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

PANiXiDA merged 15 commits into
mainfrom
feature/api-documentation

Conversation

@PANiXiDA

@PANiXiDA PANiXiDA commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Изменения

  • Общий каталог OpenAPI/AsyncAPI, JSON Schema из source-generated контекстов и генерация AsyncAPI 3.0 без ASP.NET Core, Scalar или Wolverine.
  • Запрос и reply теперь используют один канал. У операции остаются отдельные списки messages и reply.messages; синтетические .reply-каналы удалены. Это убирает повторные разделы с одним адресом в Scalar.
  • Отображаемые заголовки отделены от технических ID через ApiOperationMetadata, AsyncApiOperation.Name и AsyncApiMessage.Title.
  • Локальные JSON Pointer ссылки в $ref и $dynamicRef переносятся вместе со схемой; сохраняются $id-ресурсы схем и литеральные данные; URI-ссылки корректно экранируются; коллизии и несовместимые серверы проверяются явно.

Проверка

Локально прошли restore, format, Release build и 56 тестов; покрытие исходников 100% строк и ветвей. Новые проверки воспроизвели дублирование каналов до исправления. CI и Sonar текущего коммита прошли.

Команды: dotnet restore, dotnet format, dotnet build -c Release, dotnet test -c Release.

В браузере Scalar 2.20.0 проверены три демонстрационных хаба, два метода в одном хабе, два хаба одного модуля и отдельный модуль/версия. Каналов стало 2 вместо 5 для Matchmaking и 1 вместо 2 для Battle. Replies, обычный результат, stream item и error отображаются внутри своих операций. Реальные WebSocket-вызовы и серверный стрим прошли.

Сравнение JSON до/после подтвердило полное совпадение components, ID операций и остальных полей операций, кроме перемещённых reply-ссылок. Все 191 тест SignalR с текущими исходниками общего пакета прошли.

Контракты и зависимости

ID операций, имена и ключи message-компонентов, wire targets и payload-схемы сохранены. Меняется граф документа: reply.channel и reply.messages ссылаются на существующий канал. Миграций и новых настроек нет.

Новый NuGet/API с IsAotCompatible и статической генерацией. Отдельных AOT-проектов и AOT job нет. Сначала публикация этого пакета, затем Scalar и транспортных адаптеров; зависимости ограничены 1.x.

@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-10T19:39:16.331786Z 7757021 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.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ffb92d1c81

ℹ️ 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

Copy link
Copy Markdown
Contributor Author

@codex

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 25358ef3b8

ℹ️ 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

Copy link
Copy Markdown
Contributor Author

@codex

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: bdcccb8614

ℹ️ 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".

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Already looking forward to the next diff.

Reviewed commit: 775702122e

ℹ️ 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-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. Chef's kiss.

Reviewed commit: 775702122e

ℹ️ 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 bdf1b4c into main Nov 10, 2026
8 checks passed
@PANiXiDA
PANiXiDA deleted the feature/api-documentation branch November 10, 2026 19:40
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