Misskey doc執筆メモ

Created on September 9, 2022

updateAt : ユーザーが最後にアクティブだった？それとも投稿した？
endpoints/announcements: isoStringにする必要ある？
docker.md ; master branch?
how to add moderator
easier Docker installation tutorial/guide
パーミッションまとめほしい
- NO_SUCH_NOTE
withFilesの挙動を合わせたい
modelのドキュメントをだな…

執筆の（私的）手順

misskey.dev/api-doc からv11のドキュメントを開き、一旦内容をhubにコピーする
sinceIdなど多くのエンドポイントに共通する項目の説明を埋める
v12の対応するソースコードを開く
ソースコードを見ながら、そのエンドポイントにユニークなパラメータ、エラーの説明を簡潔に埋める
もう一度ソースコードを見て、落とし穴・バグがないか考える。v11からの変更があれば反映する。
他のエンドポイントとの関連を考えて、必要ならばdescriptionに追記する
以下のTODOリストを編集して、次の執筆部分を選ぶ。

定型文

key	description
offset	検索結果の先頭offset個をスキップします。
limit	取得する(object)の最大数
untilId	指定すると、idがその値よりも小さい(object)を返します。
sinceId	指定すると、idがその値よりも大きい(object)を返します。

用語集

英語	日本語	避ける英語	避ける日本語
note	ノート	post	投稿、ポスト
Renote	リノート（？）
reply	返信		リプライ

TODO

以下は tree の結果から未執筆・未完成のエンドポイントドキュメントをリストアップしたもの。

.
├── antennas
│   ├── create.json5
│   ├── delete.json5
│   ├── list.json5
│   ├── notes.json5
│   ├── show.json5
│   └── update.json5
├── ap/
│   ├── get.json5
│   └── show.json5
├── app
│   ├── create.json5
│   └── show.json5
├── channels
│   ├── create.json5
│   ├── featured.json5
│   ├── followed.json5
│   ├── follow.json5
│   ├── owned.json5
│   ├── show.json5
│   ├── timeline.json5
│   ├── unfollow.json5
│   └── update.json5
├── charts
│   ├── active-users.json5
│   ├── ap-request.json5
│   ├── drive.json5
│   ├── federation.json5
│   ├── hashtag.json5
│   ├── instance.json5
│   ├── notes.json5
│   ├── user
│   │   ├── drive.json5
│   │   ├── following.json5
│   │   ├── notes.json5
│   │   └── reactions.json5
│   └── users.json5
├── clips/notes.json5 - generateVisibilityは外に出すべき？ https://github.com/misskey-dev/misskey/issues/8317
├── drive.json5 - stale?
├── endpoint.json5
├── endpoints.json5
├── fetch-rss.json5
├── gallery
│   ├── featured.json5
│   ├── popular.json5
│   ├── posts
│   │   ├── create.json5
│   │   ├── delete.json5
│   │   ├── like.json5
│   │   ├── show.json5
│   │   ├── unlike.json5
│   │   └── update.json5
│   └── posts.json5
├── messaging
│   ├── history.json5
│   ├── messages
│   │   ├── create.json5
│   │   ├── delete.json5
│   │   └── read.json5
│   └── messages.json5
├── meta.json5
├── my
│   └── apps.json5
├── notes
│   ├── mentions.json5 - visibilityはenumにしたい
│   ├── state.json5 - NO_SUCH_NOTEを返したい
│   ├── translate.json5 - リンク貼りたい、OpenAPI
│   ├── user-list-timeline.json5 - これフィルタできてるか？ https://github.com/misskey-dev/misskey/issues/6093
├── promo
│   └── read.json5
├── request-reset-password.json5
├── reset-password.json5
├── sw なにこれ？
│   ├── register.json5
│   └── unregister.json5
├── test.json5
├── users
│   ├── clips.json5
│   ├── followers.json5
│   ├── following.json5
│   ├── gallery
│   │   └── posts.json5
│   ├── lists
│   │   ├── create.json5
│   │   ├── delete.json5
│   │   ├── list.json5
│   │   ├── pull.json5
│   │   ├── push.json5
│   │   ├── show.json5
│   │   └── update.json5
│   ├── notes.json5
│   ├── relation.json5
└── users.json5

Admin:

├── admin
│   ├── abuse-user-reports.json5
│   ├── accounts
│   │   ├── create.json5
│   │   └── delete.json5
│   ├── ad
│   │   ├── create.json5
│   │   ├── delete.json5
│   │   ├── list.json5
│   │   └── update.json5
│   ├── announcements
│   │   ├── create.json5
│   │   ├── delete.json5
│   │   ├── list.json5
│   │   └── update.json5
│   ├── delete-account.json5
│   ├── delete-all-files-of-a-user.json5
│   ├── drive
│   │   ├── clean-remote-files.json5
│   │   ├── cleanup.json5
│   │   ├── files.json5
│   │   └── show-file.json5
│   ├── drive-capacity-override.json5
│   ├── emoji
│   │   ├── add-aliases-bulk.json5
│   │   ├── add.json5
│   │   ├── copy.json5
│   │   ├── delete-bulk.json5
│   │   ├── delete.json5
│   │   ├── list.json5
│   │   ├── list-remote.json5
│   │   ├── remove-aliases-bulk.json5
│   │   ├── set-aliases-bulk.json5
│   │   ├── set-category-bulk.json5
│   │   └── update.json5
│   ├── federation
│   │   ├── delete-all-files.json5
│   │   ├── refresh-remote-instance-metadata.json5
│   │   ├── remove-all-following.json5
│   │   └── update-instance.json5
│   ├── get-index-stats.json5
│   ├── get-table-stats.json5
│   ├── get-user-ips.json5
│   ├── invite.json5
│   ├── meta.json5
│   ├── moderators
│   │   ├── add.json5
│   │   └── remove.json5
│   ├── promo
│   │   └── create.json5
│   ├── queue
│   │   ├── clear.json5
│   │   ├── deliver-delayed.json5
│   │   ├── inbox-delayed.json5
│   │   └── stats.json5
│   ├── relays
│   │   ├── add.json5
│   │   ├── list.json5
│   │   └── remove.json5
│   ├── reset-password.json5
│   ├── resolve-abuse-user-report.json5
│   ├── send-email.json5
│   ├── server-info.json5
│   ├── show-moderation-logs.json5
│   ├── show-user.json5
│   ├── show-users.json5
│   ├── silence-user.json5
│   ├── suspend-user.json5
│   ├── unsilence-user.json5
│   ├── unsuspend-user.json5
│   ├── update-meta.json5
│   ├── update-user-note.json5
│   └── vacuum.json5

Backlinks

There are no notes linking to this note.