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ドキュメントのパス問題を解決するためのモジュール名の変更 #14

Merged
merged 1 commit into from
Feb 13, 2024

Conversation

yuminn-k
Copy link
Member

@yuminn-k yuminn-k commented Feb 13, 2024

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

このPRは、Swaggerドキュメントにアクセスできない問題を解決することを目的としています。モジュール名がminoriからgithub.com/YJU-OKURA/project_minori-gin-deployment-repoに変更され、パスの不一致が原因で発生していた問題を修正します。

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

  • go.modファイル内のモジュール名をminoriからgithub.com/YJU-OKURA/project_minori-gin-deployment-repoに変更しました。
  • Swaggerドキュメントへのアクセス問題を解決しました。

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

なし

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

モジュール名の変更がプロジェクト全体に与える影響に注目してください。

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

  • 変更後、Swaggerドキュメントが正常に表示されるかどうかを確認してください。

📚 関連するIssueやドキュメントのリンク

🖥 作動する様子

Swagger document

📌 PRを行う際の注意点

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

📝 AssigneeのためのCheckList

  • go.modファイル内のモジュール名がgithub.com/YJU-OKURA/project_minori-gin-deployment-repoに正しく更新されたことを確認する。
  • Swaggerドキュメントが新しいモジュールパスで正確に動作することを確認する。
  • コード全体でのパス依存関係に問題がないことを確認する。
  • 変更による影響が他の部分に及ばないことを確認する。

- Change the module name in go.mod from 'minori' to 'github.com/YJU-OKURA/project_minori-gin-deployment-repo'.
- This update resolves the issue where Swagger documentation was not accessible due to a module path mismatch.
- Ensure consistent and correct import paths across the project.

Related issue: YJU-OKURA#9
@yuminn-k yuminn-k added ⚙ Setting 개발 환경 세팅 ⏰ P3 추가적인 의견 제시나 소소한 개선사항 🐞 BugFix Something isn't working 📬 API 서버 API 통신 labels Feb 13, 2024
Copy link

cr-gpt bot commented Feb 13, 2024

Seems you are using me but didn't get OPENAI_API_KEY seted in Variables/Secrets for this repo. you could follow readme for more information

@yuminn-k yuminn-k merged commit 7aef6c2 into YJU-OKURA:main Feb 13, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📬 API 서버 API 통신 🐞 BugFix Something isn't working ⏰ P3 추가적인 의견 제시나 소소한 개선사항 ⚙ Setting 개발 환경 세팅
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants