Sharkey/src/server/api/endpoints/i/unpin.ts
YuzuRyo61 a07d753da8
APIドキュメントの改善 (#6757)
* 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 #6757

* Apply reviews #6757

Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>
2021-03-06 22:34:11 +09:00

53 lines
1.1 KiB
TypeScript

import $ from 'cafy';
import { ID } from '../../../../misc/cafy-id';
import { removePinned } from '../../../../services/i/pin';
import define from '../../define';
import { ApiError } from '../../error';
import { Users } from '../../../../models';
export const meta = {
desc: {
'ja-JP': '指定した投稿のピン留めを解除します。'
},
tags: ['account', 'notes'],
requireCredential: true as const,
kind: 'write:account',
params: {
noteId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID'
}
}
},
errors: {
noSuchNote: {
message: 'No such note.',
code: 'NO_SUCH_NOTE',
id: '454170ce-9d63-4a43-9da1-ea10afe81e21'
},
},
res: {
type: 'object' as const,
optional: false as const, nullable: false as const,
ref: 'User'
}
};
export default define(meta, async (ps, user) => {
await removePinned(user, ps.noteId).catch(e => {
if (e.id === 'b302d4cf-c050-400a-bbb3-be208681f40c') throw new ApiError(meta.errors.noSuchNote);
throw e;
});
return await Users.pack(user, user, {
detail: true
});
});