docs: update CHANGELOG.md

pull/107/head
yupix 10 months ago
parent c3763504cb
commit 6dcbe15fae
No known key found for this signature in database
GPG Key ID: 2FF705F5C56D9C06

@ -2,8 +2,67 @@
## [Unreleased]
### New Features ✨
## [0.5.99] 2023-12-03
このリリースは最新の Misskey 向けに最適化された `develop` ブランチの物となります。インスタンスで `v11``v12` を利用している場合は更新しないことをおすすめします。
### Breaking changes 💔
#### v13 に合わせてメソッドやモデルを整理しました
主に削除されたモデルはチャットです。その他にも `admin` 向けのエンドポイントで既に削除されている物を削除しました。
v13 でのリクエストボディーに合わせて引数の追加なども行っています。
#### pypi からダウンロードできる MiPAC は最新の Misskey のみをサポートするようになります。
詳しくは[こちらの Issue](https://github.com/yupix/MiPAC/issues/94)を御覧ください。
今まで通りの全てのバージョンをサポートした MiPAC を利用したい場合は以下のコマンドで `shared` ブランチの物をご利用いただけます。
今後 `v11``v12` のブランチを作成しそれぞれの最新のバージョンをサポートする予定です。そのため、`shared` ブランチは保守モードに入り、基本的にはバグの修正のみを提供します。機能追加も行う可能性はありますが、v11 や v12、最新の Misskey のサポートが終わってからになります。
```bash
pip install git+https://github.com/yupix/Mi.py.git@shared
```
#### `Lite*` から始まるモデルの名前が `Partial*` に変更されます。
今まで Lite と Partial が混在していましたが、今回のアップデートを期に `Partial` に統一されます
### メソッドの変更
| v0.5.0 | v0.6.0 |
| -------------------------------- | ------------------------------------ |
| `ClientNoteActions.get_children` | `ClientNoteActions.get_all_children` |
| `ClientNoteActions.get_reaction` | `ClientNoteActions.get_reactions` |
### Drive周りの作り直し
Driveに関するManagerやActionsを全て作り直しました。詳細に記述してるといつまでも終わらないので、ご迷惑をおかけしますが、確認していただけると幸いです🙏
### モデルの変更
一部のモデルがより良い形で再実装されました。結果的にモデル名が変わっています。以下がその変更後の表になります。
| v0.5.0 | v0.6.0 | 変更理由 |
| -------- | ----------- | ---------------------------------------------------------------------------------- |
| UserRole | PartialRole | Role と共通していた為 User よりも Role の Partial クラスにする方が適切だと考えた為 |
|PartialNote|Note|分ける必要性が無かったため(実際どこにも使用していなかった)|
### 非推奨になったモデル/クラス
| 名前 | 削除されるバージョン | 理由 |
| -------- | -------------------- | ------------------ |
| UserRole | 0.7.0 | PartialRole に変更 |
### Other notable changes 📜
- `mipac.util` モジュールが削除されました
- 例外 `CredentialsError` が追加されました
## [0.5.1] 2023-10-03
### New Features ✨
#### `MeDetailed` モデルが追加され、自身に関する情報より多く扱えるようになりました
@ -11,7 +70,6 @@
`MeDetailed``UserDetailed` の共有体型の場合は `isinstance` を用いて判断が行えます。
また、`RoleUser` 等のように専用のユーザーモデルがある場合は `MeRole` のようなモデルを作成し、どちらかを返すようになります。
※まだ全てのメソッドに適応されたわけではなく、ごく一部のみの適応となっています。
```py
@ -29,7 +87,7 @@ async def main():
#### 以下のエンドポイントがサポートされました
| エンドポント | MiPAC でのメソッド |
|---|---|
| -------------------------- | ----------------------------------------- |
| `/api/admin/invite/create` | `api.admin.invite.action.create_invite` |
| `/api/admin/invite/list` | `api.admin.invite.action.get_invite_list` |
| `/api/roles/list` | `api.role.action.get_list` |
@ -94,17 +152,18 @@ print(note_one == note_three, note_one != note_three)
+ await file.api.action.remove()
```
#### `FileActions``save` メソッドが追加されました
指定したパス、または Buffer にファイルをダウンロードできるようになりました。
パスを指定する場合
```py
async for file in api.drive.file.action.get_files(get_all=True):
await file.api.action.save(f'./test/{file.name}')
```
Buffer を指定する場合:
```py
async for file in api.drive.file.action.get_files(get_all=True):
with open(f'./test/{file.name}', mode='mb') as f:

Loading…
Cancel
Save