mirror of
https://git.joinsharkey.org/Sharkey/Sharkey.git
synced 2024-11-27 19:03:08 +02:00
Improve API documentation
This commit is contained in:
parent
2e22874dec
commit
a515c1f53e
21 changed files with 80 additions and 2 deletions
|
@ -17,6 +17,10 @@ export const meta = {
|
||||||
userId: {
|
userId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象のユーザーのID',
|
||||||
|
'en-US': 'Target user ID'
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
|
@ -17,6 +17,10 @@ export const meta = {
|
||||||
userId: {
|
userId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象のユーザーのID',
|
||||||
|
'en-US': 'Target user ID'
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
|
@ -17,6 +17,10 @@ export const meta = {
|
||||||
userId: {
|
userId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象のユーザーのID',
|
||||||
|
'en-US': 'Target user ID'
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
|
@ -16,6 +16,10 @@ export const meta = {
|
||||||
userId: {
|
userId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象のユーザーのID',
|
||||||
|
'en-US': 'Target user ID'
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
|
@ -16,6 +16,10 @@ export const meta = {
|
||||||
userId: {
|
userId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象のユーザーのID',
|
||||||
|
'en-US': 'Target user ID'
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
|
@ -13,6 +13,10 @@ export const meta = {
|
||||||
userId: {
|
userId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象のユーザーのID',
|
||||||
|
'en-US': 'Target user ID'
|
||||||
|
}
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
|
@ -19,6 +19,10 @@ export const meta = {
|
||||||
userId: {
|
userId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象のユーザーのID',
|
||||||
|
'en-US': 'Target user ID'
|
||||||
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
limit: {
|
limit: {
|
||||||
|
|
|
@ -25,6 +25,10 @@ export const meta = {
|
||||||
userId: {
|
userId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象のユーザーのID',
|
||||||
|
'en-US': 'Target user ID'
|
||||||
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
text: {
|
text: {
|
||||||
|
|
|
@ -17,6 +17,10 @@ export const meta = {
|
||||||
userId: {
|
userId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象のユーザーのID',
|
||||||
|
'en-US': 'Target user ID'
|
||||||
|
}
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
|
@ -17,6 +17,10 @@ export const meta = {
|
||||||
userId: {
|
userId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象のユーザーのID',
|
||||||
|
'en-US': 'Target user ID'
|
||||||
|
}
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
|
@ -14,6 +14,10 @@ export const meta = {
|
||||||
noteId: {
|
noteId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象の投稿のID',
|
||||||
|
'en-US': 'Target note ID'
|
||||||
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
limit: {
|
limit: {
|
||||||
|
|
|
@ -21,6 +21,10 @@ export const meta = {
|
||||||
noteId: {
|
noteId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象の投稿のID',
|
||||||
|
'en-US': 'Target note ID'
|
||||||
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
choice: {
|
choice: {
|
||||||
|
|
|
@ -17,6 +17,10 @@ export const meta = {
|
||||||
noteId: {
|
noteId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象の投稿のID',
|
||||||
|
'en-US': 'Target note ID'
|
||||||
|
}
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
|
@ -14,6 +14,10 @@ export const meta = {
|
||||||
noteId: {
|
noteId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象の投稿のID',
|
||||||
|
'en-US': 'Target note ID'
|
||||||
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
limit: {
|
limit: {
|
||||||
|
|
|
@ -14,6 +14,10 @@ export const meta = {
|
||||||
noteId: {
|
noteId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象の投稿のID',
|
||||||
|
'en-US': 'Target note ID'
|
||||||
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
limit: {
|
limit: {
|
||||||
|
|
|
@ -17,6 +17,10 @@ export const meta = {
|
||||||
userId: {
|
userId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象のユーザーのID',
|
||||||
|
'en-US': 'Target user ID'
|
||||||
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
limit: {
|
limit: {
|
||||||
|
|
|
@ -17,6 +17,10 @@ export const meta = {
|
||||||
userId: {
|
userId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象のユーザーのID',
|
||||||
|
'en-US': 'Target user ID'
|
||||||
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
limit: {
|
limit: {
|
||||||
|
|
|
@ -10,6 +10,10 @@ export const meta = {
|
||||||
userId: {
|
userId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象のユーザーのID',
|
||||||
|
'en-US': 'Target user ID'
|
||||||
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
limit: {
|
limit: {
|
||||||
|
|
|
@ -26,6 +26,10 @@ export const meta = {
|
||||||
userId: {
|
userId: {
|
||||||
validator: $.type(ID),
|
validator: $.type(ID),
|
||||||
transform: transform,
|
transform: transform,
|
||||||
|
desc: {
|
||||||
|
'ja-JP': '対象のユーザーのID',
|
||||||
|
'en-US': 'Target user ID'
|
||||||
|
}
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
|
@ -15,7 +15,8 @@ export const meta = {
|
||||||
validator: $.type(ID).optional,
|
validator: $.type(ID).optional,
|
||||||
transform: transform,
|
transform: transform,
|
||||||
desc: {
|
desc: {
|
||||||
'ja-JP': 'ユーザーID'
|
'ja-JP': '対象のユーザーのID',
|
||||||
|
'en-US': 'Target user ID'
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
|
|
|
@ -17,7 +17,8 @@ export const meta = {
|
||||||
validator: $.type(ID).optional,
|
validator: $.type(ID).optional,
|
||||||
transform: transform,
|
transform: transform,
|
||||||
desc: {
|
desc: {
|
||||||
'ja-JP': 'ユーザーID'
|
'ja-JP': '対象のユーザーのID',
|
||||||
|
'en-US': 'Target user ID'
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue