summaryrefslogtreecommitdiff
path: root/src/server/api/endpoints/notes/delete.ts
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2018-10-22 05:16:27 +0900
committersyuilo <syuilotan@yahoo.co.jp>2018-10-22 05:16:27 +0900
commit3aece449e4a2134381d69754716906353c2dd8bf (patch)
tree6effa7785bb5f34b79696f4734d236267cb5f361 /src/server/api/endpoints/notes/delete.ts
parent#2939 part 3 (#2976) (diff)
downloadsharkey-3aece449e4a2134381d69754716906353c2dd8bf.tar.gz
sharkey-3aece449e4a2134381d69754716906353c2dd8bf.tar.bz2
sharkey-3aece449e4a2134381d69754716906353c2dd8bf.zip
Improve API definitions
Diffstat (limited to 'src/server/api/endpoints/notes/delete.ts')
-rw-r--r--src/server/api/endpoints/notes/delete.ts21
1 files changed, 16 insertions, 5 deletions
diff --git a/src/server/api/endpoints/notes/delete.ts b/src/server/api/endpoints/notes/delete.ts
index 2fe36897c0..160d5c4cf6 100644
--- a/src/server/api/endpoints/notes/delete.ts
+++ b/src/server/api/endpoints/notes/delete.ts
@@ -2,8 +2,11 @@ import $ from 'cafy'; import ID from '../../../../misc/cafy-id';
import Note from '../../../../models/note';
import deleteNote from '../../../../services/note/delete';
import User, { ILocalUser } from '../../../../models/user';
+import getParams from '../../get-params';
export const meta = {
+ stability: 'stable',
+
desc: {
'ja-JP': '指定した投稿を削除します。',
'en-US': 'Delete a note.'
@@ -11,17 +14,25 @@ export const meta = {
requireCredential: true,
- kind: 'note-write'
+ kind: 'note-write',
+
+ params: {
+ noteId: $.type(ID).note({
+ desc: {
+ 'ja-JP': '対象の投稿のID',
+ 'en-US': 'Target note ID.'
+ }
+ })
+ }
};
export default (params: any, user: ILocalUser) => new Promise(async (res, rej) => {
- // Get 'noteId' parameter
- const [noteId, noteIdErr] = $.type(ID).get(params.noteId);
- if (noteIdErr) return rej('invalid noteId param');
+ const [ps, psErr] = getParams(meta, params);
+ if (psErr) return rej(psErr);
// Fetch note
const note = await Note.findOne({
- _id: noteId
+ _id: ps.noteId
});
if (note === null) {