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.

Sign up for GitHub

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

Jump to bottom

APIにPOSTする際に要求される冗長な必須項目を減らして欲しい #13398

Open
1 task
Sayamame-beans opened this issue Feb 19, 2024 · 0 comments · May be fixed by #13824
Open
1 task

APIにPOSTする際に要求される冗長な必須項目を減らして欲しい #13398

Sayamame-beans opened this issue Feb 19, 2024 · 0 comments · May be fixed by #13824
Labels
🧩API Interface between server and client ✨Feature This adds/improves/enhances a feature packages/backend Server side specific issue/PR

Comments

@Sayamame-beans
Copy link
Member

Summary

#13396 でflash/updateについて言及されていますが、他のエンドポイントについても同様なものがあるようです。
複数のうちどれか1つが必要な場合はanyOfを使用した方が良さそうです。

例:

misskey/packages/backend/src/server/api/endpoints/clips/update.ts

Line 44 in 034f472

required: ['clipId', 'name'],

misskey/packages/backend/src/server/api/endpoints/admin/emoji/update.ts

Line 60 in 034f472

required: ['id', 'name', 'aliases'],

misskey/packages/backend/src/server/api/endpoints/pages/update.ts

Line 73 in 034f472

required: ['pageId', 'title', 'name', 'content', 'variables', 'script'],

misskey/packages/backend/src/server/api/endpoints/i/webhooks/update.ts

Line 43 in 034f472

required: ['webhookId', 'name', 'url', 'on', 'active'],

misskey/packages/backend/src/server/api/endpoints/antennas/update.ts

Line 70 in 034f472

required: ['antennaId', 'name', 'src', 'keywords', 'excludeKeywords', 'users', 'caseSensitive', 'withReplies', 'withFile', 'notify'],

misskey/packages/backend/src/server/api/endpoints/gallery/posts/update.ts

Line 50 in 034f472

required: ['postId', 'title', 'fileIds'],

misskey/packages/backend/src/server/api/endpoints/admin/ad/update.ts

Line 43 in 034f472

required: ['id', 'memo', 'url', 'imageUrl', 'place', 'priority', 'ratio', 'expiresAt', 'startsAt', 'dayOfWeek'],

Purpose

APIの利便性向上

Do you want to implement this feature yourself?

  • Yes, I will implement this by myself and send a pull request
@Sayamame-beans Sayamame-beans added the ✨Feature This adds/improves/enhances a feature label Feb 19, 2024
@FineArchs FineArchs mentioned this issue Feb 24, 2024
Merged
5 tasks
@yupix yupix mentioned this issue Mar 7, 2024
Merged
5 tasks
@yupix yupix linked a pull request May 12, 2024 that will close this issue
Open
5 tasks
@KisaragiEffective KisaragiEffective added 🧩API Interface between server and client packages/backend Server side specific issue/PR labels Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🧩API Interface between server and client ✨Feature This adds/improves/enhances a feature packages/backend Server side specific issue/PR
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

refactor: api/*/update系の必須キーを最低限に yupix/misskey
2 participants
@KisaragiEffective @Sayamame-beans