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.
やったこと
https://misskey-hub.net/docs/api/endpoints/channels/show.html を確認したときに、そこからの Channel 型へのリンク先が 404 だったので、
channel
の型情報を追加しました。調べたこと
過去に同様の追加のPR がなかったのですが、
misskey-hub/src/.vuepress/generate-endpoint-pages.ts
Lines 103 to 108 in 6b9d9eb
src/docs/api/common.json5
を編集しました。型の情報は https://github.com/misskey-dev/misskey/blob/30bb24d18c7d3f214114207dfe493ca9a9fe1faf/packages/backend/src/models/json-schema/channel.ts を参考にしました。
既存の型情報を見るに、 nullable などの情報は書かれていなかったので、書いていません。
misskey-hub/src/docs/api/common.json5
Lines 34 to 62 in 6b9d9eb
確認したこと
http://localhost:8080/docs/api/entity/channel.html
で問題なく表示されていました。レビューお願いします 🙏
misskey-dev/misskey-hub-next#6 も読んだのですが、全体の方針がわからなかったので一旦PRを出しましたが、別にプロジェクトが走ってたらクローズお願いします