Improve API documentation

This commit is contained in:
syuilo 2018-11-03 22:49:36 +09:00
parent 2e22874dec
commit a515c1f53e
No known key found for this signature in database
GPG key ID: BDC4C49D06AB9D69
21 changed files with 80 additions and 2 deletions

View file

@ -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'
}
} }
} }
}; };

View file

@ -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'
}
} }
} }
}; };

View file

@ -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'
}
} }
} }
}; };

View file

@ -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'
}
} }
} }
}; };

View file

@ -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'
}
} }
} }
}; };

View file

@ -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'
}
}, },
} }
}; };

View file

@ -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: {

View file

@ -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: {

View file

@ -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'
}
}, },
} }
}; };

View file

@ -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'
}
}, },
} }
}; };

View file

@ -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: {

View file

@ -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: {

View file

@ -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'
}
}, },
} }
}; };

View file

@ -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: {

View file

@ -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: {

View file

@ -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: {

View file

@ -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: {

View file

@ -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: {

View file

@ -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'
}
}, },
} }
}; };

View file

@ -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'
} }
}, },

View file

@ -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'
} }
}, },