ENH: OpenAPIのドキュメントを改良 #1438
Merged
ENH: OpenAPIのドキュメントを改良 #1438
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sabonerune
commented
Jun 26, 2024
Comment on lines
-51
to
+52
| title="エラー名", | ||
| description="|name|description|\n|---|---|\n" | ||
| description="エラー名\n\n" | ||
| "|name|description|\n|---|---|\n" |
There was a problem hiding this comment.
既にdescriptionが使用されていたので改行で対応した。
Comment on lines
+23
to
26
| description=( | ||
| "スタイルの種類。" | ||
| "talk:音声合成クエリの作成と音声合成が可能。" | ||
| "singing_teacher:歌唱音声合成用のクエリの作成が可能。" |
There was a problem hiding this comment.
直接関係はないのだが改行されないので見にくい気がする。
There was a problem hiding this comment.
そもそもスキーマは別リンクになっていて欲しい気もしますね。。
Hiroshiba
approved these changes
Jun 26, 2024
There was a problem hiding this comment.
LGTM！！
今思ったんですが、そもそも結構見づらいですね。。
画面が広い時に右に表示されるjsonサンプルみたいなのがいらなさそう･･･？（いる人もいるかもだけど。。）
ドキュメント読んだ感じ、設定は色々ありそう。
https://redocly.com/docs/redoc/config
Hiroshiba
approved these changes
Jun 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
内容
OpenAPIのドキュメントをより見やすくします。
#1318 (comment) で分かったことなのですが
Fieldのtitle引数でモデルの要素の説明を書くとSwagger UIでは表示されないことが分かりました。また、
descriptionの方に書くと表示されることが分かりました。descriptionの方が分かりやすいと思うので変更します。関連 Issue
speaker_infoのリソースをURLで返すようにする #1318 (comment)スクリーンショット・動画など
変更後のイメージ
その他
APIの動作には影響はないはず。
一部で既に
descriptionを使用している部分があったので改行で対応。