Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

画面共有機能の強化とSwaggerドキュメントの更新 #209

Merged
merged 2 commits into from
Apr 22, 2024

Conversation

yuminn-k
Copy link
Member

🔍 このPRで解決したい問題は何ですか?

  • このPRでは、ライブクラスの画面共有機能の拡張と、関連するSwaggerドキュメントの更新を行います。画面共有機能に新たに接続状態の確認機能を追加し、更に安定したサービス提供を目指します。また、APIの使用方法を正確に理解してもらうために、Swaggerのドキュメントも更新しました。
  • [MIN-145] 画面共有機能の実装 #80
  • 관리자(管理者) - 화면공유(画面共有)

✨ このPRで主に変わったことは何ですか?

  • ライブクラスの画面共有開始時に接続状態をチェックするロジックを追加しました。
  • 画面共有の安定性向上のためのICEギャザリング処理の改善を行いました。
  • Swaggerドキュメントに新しいエンドポイントとパラメータを反映しました。

🔖 主な変更点以外に追加で変更された部分はありますか?

  • なし

🙏🏻 Reviewerに特に見ていただきたい部分はありますか?

  • 新しい接続状態確認ロジックの効率性と効果性についてのフィードバックをお願いします。
  • Swaggerドキュメントの明確さと正確性。

🩺 このPRでテストや検証が必要な部分はありますか?

  • 新しい画面共有機能の接続確認ロジックの動作検証。
  • ドキュメントに記載されたAPIエンドポイントの動作確認。

📚 関連するIssueやTrello、ドキュメント

🖥 作動する様子

スクリーンショットや録画したビデオ、またはgifを追加して、Reviewerが変更点を理解するのに役立ててください。

📌 PRを行う際の注意点

  • Reviewerはコードレビュー時に良いコードの方向性を示しますが、コード修正を強制することはありません。
  • Reviewerは良いコードを見つけた場合、賞賛と励ましを惜しみません。
  • レビューは特別なケースでない限り、Reviewerに指定された時点から3日以内に行ってください。
  • コメント作成時にPrefixにP1、P2、P3を書いていただくと、Assigneeがより明確にコメントに対して対応することができます。
    • P1 : 必ず反映してください (Request Changes) - 問題が発生したり、脆弱性が発見されたケースなど。
    • P2 : 反映を積極的に検討していただければと思います (コメント)。
    • P3 : こんな方法もあるんじゃないかな~などの些細な意見です (Chore)。

This commit introduces comprehensive updates to the live class screen sharing feature. It includes the creation, start, and stop handlers for screen sharing sessions within our live class environment. The commit also refactors existing code to improve stability and performance during screen sharing sessions. Changes include error handling enhancements and better state management for the WebRTC peer connections, ensuring robust session control. Additionally, the Swagger documentation has been updated to reflect the new API endpoints and their functionalities.

Related issue: YJU-OKURA#80
Updated the Swagger API documentation to include the new endpoints and parameters introduced for managing screen sharing in live classes. This documentation now accurately reflects the endpoints for creating rooms, starting and stopping screen sharing, and joining screen shares, complete with necessary authentication details and expected responses for success or failure scenarios. This update ensures that API consumers have accurate and detailed information for integrating with our live class features.

Related issue: YJU-OKURA#80
@yuminn-k yuminn-k added ⏰ P1 반드시 해결해야 하는 중요한 이슈나 문제 (예: 버그, 취약점 등) ⚙ Setting 개발 환경 세팅 ✨ Feature 기능 개발 🔨 Refactor 코드 리팩토링 📬 API 서버 API 통신 📃 Docs 문서 작성 및 수정 (README.md 등) 🆗 safe CI workflow 동작 관련 labels Apr 22, 2024
go.mod Show resolved Hide resolved
go.sum Show resolved Hide resolved
main.go Show resolved Hide resolved
Copy link
Collaborator

@Regulus0811 Regulus0811 left a comment

Choose a reason for hiding this comment

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

お疲れ様でした👍

@yuminn-k yuminn-k merged commit bf0e319 into YJU-OKURA:main Apr 22, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📬 API 서버 API 통신 📃 Docs 문서 작성 및 수정 (README.md 등) ✨ Feature 기능 개발 ⏰ P1 반드시 해결해야 하는 중요한 이슈나 문제 (예: 버그, 취약점 등) 🔨 Refactor 코드 리팩토링 🆗 safe CI workflow 동작 관련 ⚙ Setting 개발 환경 세팅
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants