Skip to content

Conversation

@hikahana
Copy link
Contributor

対応Issue

resolve #0

概要

実装詳細

画面スクリーンショット等

テスト項目

  • [ ]
  • [ ]
  • [ ]

備考

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

oas_docsからopenapiへの移行を実施し、OpenAPIドキュメント生成ツールの変更を行っています。

  • r2-oas gemから openapi-generator-cli Dockerイメージへの移行
  • OpenAPIファイルの統合と配置変更(api/oas_docs/からopenapi/へ)
  • 新しいOpenAPI Generator用のスクリプトとMakefileタスクの追加

Reviewed Changes

Copilot reviewed 10 out of 281 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
scripts/openapi-generator OpenAPI Generator CLIをDockerで実行するための新しいbashスクリプト
openapi/meta.yml 分散していたOpenAPI設定を統合した新しいメタファイル
compose.swagger.yml Swagger UI用のボリュームマウントパスを新しい構造に更新
api/oas_docs/src/* 古いOAS設定ファイルを削除(tags.yml, servers.yml, openapi.yml, external_docs.yml)
api/Gemfile r2-oas gemの依存関係を削除
README.md OpenAPI Generatorの使用方法に関するドキュメントを追加
Makefile OpenAPI Generator操作用の新しいMakefileタスクを追加

Comment on lines +18 to +20
externalDocs:
description: ''
url: ''
Copy link

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

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

空の文字列を設定するより、適切な値を入れるかプロパティ自体を削除した方がよいっぽい!😊 OpenAPIスキーマでは空文字列より意味のある値を入れるか、オプショナルなプロパティは省略するのがベストプラクティスなの💫

Copilot uses AI. Check for mistakes.
Comment on lines +27 to +29
externalDocs:
description: description
url: url
Copy link

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

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

プレースホルダーテキスト('description', 'url')が残ってるよ〜😅 実際の値に置き換えるか、もしくは適切な値がない場合はこのセクション自体を削除した方がいいかも✨

Suggested change
externalDocs:
description: description
url: url

Copilot uses AI. Check for mistakes.
-o api/generated/server
```
- 生成物の出力先はマウント済みのリポジトリ内なら自由に指定できます。
- `make openapi-cli cmd="<コマンド>"` で CLI をそのまま呼び出せます(例: `cmd="version"`)。
Copy link

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

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

このドキュメントちょっと混乱しちゃうかも😵‍💫 実際のMakefileにはopenapi-cliタスクがあるけど、例としてcmd=\"version\"って書いてあるのに、実際に実行するとmake openapi-cli cmd=\"version\"になるから、具体例をもっと明確にした方がいいっぽい!💡

Suggested change
- `make openapi-cli cmd="<コマンド>"` で CLI をそのまま呼び出せます(例: `cmd="version"`)。
- `make openapi-cli cmd="<コマンド>"` で CLI をそのまま呼び出せます(例: `make openapi-cli cmd="version"`)。

Copilot uses AI. Check for mistakes.
@hikahana
Copy link
Contributor Author

@codex レビューできる?

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