fix: fixed Note and User (#212)

[myConsciousness]

こんにちは。

#212 で挙げた件について、
common.json5にあるNoteとUserの定義を実際のJSON構造に沿うように修正しました。

[syuilo]

ありがとうございます！
クォーテーションの変更で差分が見にくくなってしまっているので、'で統一していただけますか？ 👀

[myConsciousness]

@syuilo

シングルクオートで修正しましたが、ほぼ新規扱いになりました 🤔

[yanorei32]

インデント幅がSpace: 4からSpace: 2に変更されている為ですね。これを直せば差分は減ると思います。

また、src/.vuepress/api.jsonによると、UserはUserLiteとUserDetailedとのUnionTypeであり、また、isBotはoptionalとなっているのですが、これは現在の実装に即しているのでしょうか。

追記:
https://github.com/misskey-dev/misskey/blob/7e8700514f18409874737cd5b439280bb03b829c/packages/backend/src/models/schema/user.ts

今軽く眺めたところ現在の実際のUser schemaは恐らくこれで、UserLiteとUserdetailedNotMeOnly、MeDetailedOnly、UserDetailedNotMe、MeDetailed並びにUserDetailedを新たに表現する必要がありそうです？

しかしこのスキーマも最終更新が16日前と活発に変更されており、これを手動にて更新し続けるのは困難を極める気がします。 #222 にIssueを建てましたが、根本的な改善が必要そうな気がします。

[myConsciousness]

@yanorei32 @syuilo

なるほど、そうなるとまずドキュメントを作るための環境と標準が整備されていないのが問題でしょう。

私はVSCodeで編集していますが、このリポジトリのためだけに私のVSCodeの設定を自分で変更したくないです。また、ドキュメント中にUnionTypeやOptionalを埋め込む方式もどこにも明文化されていません。

そもそもなのですが、頻繁に変更されるAPIなのであれば、なおさら実ソースからjson5ファイルやMarkdownを生成するジェネレータを作るべきですね。簡単に作れると思うので、検討してみてください。

[myConsciousness]

@syuilo

あと、この際なのでついでのリクエストですが、個人的にはMisskey APIのエンドポイントに関するドキュメントはちょっと使いにくいです。

というのも、例えばエンティティのフィールド情報などが最初に畳まれた状態なので、中身を見るのにいちいちクリックしないといけないです。もっとシンプルにできないものでしょうか？

まずは抜本的にドキュメントの構造をリファクタリングすることで、 @yanorei32 が示した改善もしやすくなると感じます。