Conversation
Walkthroughdocs/v2/index.htmlで、ReDocの読み込み位置をheadからbody末尾へ移動し、spec-urlをローカルopenapi.jsonからhttps://boatraceopenapi.github.io/programs/v2/openapi.jsonに変更。末尾にRedocバンドルのscriptタグを追加。 Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant U as User
participant B as Browser
participant H as docs/v2/index.html
participant S as Redoc Bundle
participant R as ReDoc
participant O as OpenAPI Spec (GH Pages)
U->>B: アクセス
B->>H: HTML取得
Note over H,B: スクリプトがbody末尾に配置(変更点)
B->>S: Redocバンドル読み込み
S->>R: 初期化
R->>O: GET https://boatraceopenapi.github.io/programs/v2/openapi.json(変更点)
O-->>R: OpenAPI JSON
R-->>B: ドキュメント描画
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/v2/index.html (1)
9-9: script タグ内の不要な空白の削除+CDNバージョン固定の検討
- 末尾の空白テキストノードは不要なので削除を。
- 「latest」では将来の破壊的変更の影響を受け得るため、可能なら CDN の特定バージョンに固定する運用を検討してください。
適用例(空白削除のみ):
- <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"> </script> + <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/v2/index.html(1 hunks)
🔇 Additional comments (1)
docs/v2/index.html (1)
8-8: spec-url の絶対URL化は妥当。公開場所の恒久性だけ確認してください。
GitHub Pages 上で当該 JSON が常時このパスで配信される前提(将来の配置変更やファイル名変更がないこと)と、正しい Content-Type で配信されているかを確認してください。
index.html の書き方を間違えていたので修正しました。
Summary by CodeRabbit
新機能
バグ修正
ドキュメント