sendnrw/misskey
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve API documentation

Browse Source
This commit is contained in:
syuilo
2018-11-03 22:49:36 +09:00
parent 2e22874dec
commit a515c1f53e
21 changed files with 80 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/server/api/endpoints/following/requests/accept.ts
View File

@@ -17,6 +17,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
}
}
};

4
src/server/api/endpoints/following/requests/cancel.ts
View File

@@ -17,6 +17,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
}
}
};

4
src/server/api/endpoints/following/requests/reject.ts
View File

@@ -17,6 +17,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
}
}
};

4
src/server/api/endpoints/following/stalk.ts
View File

@@ -16,6 +16,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
}
}
};

4
src/server/api/endpoints/following/unstalk.ts
View File

@@ -16,6 +16,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
}
}
};

4
src/server/api/endpoints/games/reversi/match.ts
View File

@@ -13,6 +13,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
}
};

4
src/server/api/endpoints/messaging/messages.ts
View File

@@ -19,6 +19,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
limit: {

4
src/server/api/endpoints/messaging/messages/create.ts
View File

@@ -25,6 +25,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
text: {

4
src/server/api/endpoints/mute/create.ts
View File

@@ -17,6 +17,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
}
};

4
src/server/api/endpoints/mute/delete.ts
View File

@@ -17,6 +17,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
}
};

4
src/server/api/endpoints/notes/conversation.ts
View File

@@ -14,6 +14,10 @@ export const meta = {
noteId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID'
}
},
limit: {

4
src/server/api/endpoints/notes/polls/vote.ts
View File

@@ -21,6 +21,10 @@ export const meta = {
noteId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID'
}
},
choice: {

4
src/server/api/endpoints/notes/reactions/delete.ts
View File

@@ -17,6 +17,10 @@ export const meta = {
noteId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID'
}
},
}
};

4
src/server/api/endpoints/notes/renotes.ts
View File

@@ -14,6 +14,10 @@ export const meta = {
noteId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID'
}
},
limit: {

4
src/server/api/endpoints/notes/replies.ts
View File

@@ -14,6 +14,10 @@ export const meta = {
noteId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID'
}
},
limit: {

4
src/server/api/endpoints/users/followers.ts
View File

@@ -17,6 +17,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
limit: {

4
src/server/api/endpoints/users/following.ts
View File

@@ -17,6 +17,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
limit: {

4
src/server/api/endpoints/users/get_frequently_replied_users.ts
View File

@@ -10,6 +10,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
limit: {

4
src/server/api/endpoints/users/lists/push.ts
View File

@@ -26,6 +26,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
}
};

3
src/server/api/endpoints/users/notes.ts
View File

@@ -15,7 +15,8 @@ export const meta = {
validator: $.type(ID).optional,
transform: transform,
desc: {
'ja-JP': 'ユーザーID'
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},

3
src/server/api/endpoints/users/show.ts
View File

@@ -17,7 +17,8 @@ export const meta = {
validator: $.type(ID).optional,
transform: transform,
desc: {
'ja-JP': 'ユーザーID'
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},