Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

APIドキュメントの改善 #6757

Merged
merged 22 commits into from Mar 6, 2021

Conversation

YuzuRyo61
Copy link
Contributor

@YuzuRyo61 YuzuRyo61 commented Oct 23, 2020

Summary

APIドキュメントのレスポンスが書いてないものが多かったので、レスポンスが返ってくるものはその形に合うようにしました。

※一部完全に書けていない部分がありますことをご了承ください。

@@ -346,6 +346,80 @@ export const packedUserSchema = {
type: 'any' as const,
nullable: true as const, optional: false as const,
},
avatarColor: {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

このプロパティ消した記憶があるけど違ったっけ

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/api/users のAPIを参照したらavatarColorが入ってました。

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

一応廃止予定で後方互換性のためだけに残してあるやつだから消した方が良さそう。

@YuzuRyo61 YuzuRyo61 requested a review from syuilo October 25, 2020 13:41
@syuilo
Copy link
Member

syuilo commented Nov 14, 2020

概ねよさそう

@syuilo syuilo merged commit a07d753 into misskey-dev:develop Mar 6, 2021
@syuilo
Copy link
Member

syuilo commented Mar 6, 2021

🙏🙏🙏

@YuzuRyo61 YuzuRyo61 deleted the api-doc-improvement branch March 6, 2021 16:59
foggy1 pushed a commit to foggy-llc/pluskey that referenced this pull request May 8, 2021
* Update api document in admin/announcements

* Update api document in announcements

* Update api document in i/read-announcements

* Update api document in username/available

* Update api document & Fix typo in API 403 error

* Update api document

* Update api document

* Update api document

* Fix API permission definition

* Update api document

* Update api document

* Update api document

* Update api document

* Update api document

* Update api document

* Update api document

* Update api document

* Fix bug in users (api)

* Apply reviews misskey-dev#6757

* Apply reviews misskey-dev#6757

Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>
snk-lab pushed a commit to snk-lab/misskey-kusa-note that referenced this pull request Sep 24, 2021
* Update api document in admin/announcements

* Update api document in announcements

* Update api document in i/read-announcements

* Update api document in username/available

* Update api document & Fix typo in API 403 error

* Update api document

* Update api document

* Update api document

* Fix API permission definition

* Update api document

* Update api document

* Update api document

* Update api document

* Update api document

* Update api document

* Update api document

* Update api document

* Fix bug in users (api)

* Apply reviews misskey-dev#6757

* Apply reviews misskey-dev#6757

Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants