Improve doc

This commit is contained in:
syuilo
2019-02-25 04:18:09 +09:00
parent 47d4dcfdf5
commit 60c9a6528f
14 changed files with 52 additions and 12 deletions

View File

@ -21,6 +21,20 @@ export const meta = {
}
},
res: {
type: 'object',
properties: {
token: {
type: 'string',
description: 'セッションのトークン'
},
url: {
type: 'string',
description: 'セッションのURL'
},
}
},
errors: {
noSuchApp: {
message: 'No such app.',

View File

@ -29,6 +29,21 @@ export const meta = {
}
},
res: {
type: 'object',
properties: {
accessToken: {
type: 'string',
description: 'ユーザーのアクセストークン',
},
user: {
type: 'User',
description: '認証したユーザー'
},
}
},
errors: {
noSuchApp: {
message: 'No such app.',

View File

@ -41,6 +41,7 @@ export const meta = {
media: {
validator: $.optional.bool,
deprecated: true,
desc: {
'ja-JP': 'ファイルが添付された投稿に限定するか否か (このパラメータは廃止予定です。代わりに withFiles を使ってください。)'
}

View File

@ -138,6 +138,7 @@ export const meta = {
mediaIds: {
validator: $.optional.arr($.type(ID)).unique().range(1, 4),
transform: transformMany,
deprecated: true,
desc: {
'ja-JP': '添付するファイル (このパラメータは廃止予定です。代わりに fileIds を使ってください。)'
}

View File

@ -24,6 +24,7 @@ export const meta = {
mediaOnly: {
validator: $.optional.bool,
deprecated: true,
desc: {
'ja-JP': 'ファイルが添付された投稿に限定するか否か (このパラメータは廃止予定です。代わりに withFiles を使ってください。)'
}

View File

@ -88,6 +88,7 @@ export const meta = {
mediaOnly: {
validator: $.optional.bool,
deprecated: true,
desc: {
'ja-JP': 'true にすると、ファイルが添付された投稿だけ取得します (このパラメータは廃止予定です。代わりに withFiles を使ってください。)'
}

View File

@ -25,6 +25,7 @@ export const meta = {
mediaOnly: {
validator: $.optional.bool,
deprecated: true,
desc: {
'ja-JP': 'ファイルが添付された投稿に限定するか否か (このパラメータは廃止予定です。代わりに withFiles を使ってください。)'
}

View File

@ -64,6 +64,7 @@ export const meta = {
media: {
validator: $.optional.nullable.bool,
default: null as any,
deprecated: true,
desc: {
'ja-JP': 'ファイルが添付された投稿に限定するか否か (このパラメータは廃止予定です。代わりに withFiles を使ってください。)'
}

View File

@ -89,6 +89,7 @@ export const meta = {
mediaOnly: {
validator: $.optional.bool,
deprecated: true,
desc: {
'ja-JP': 'true にすると、ファイルが添付された投稿だけ取得します (このパラメータは廃止予定です。代わりに withFiles を使ってください。)'
}

View File

@ -98,6 +98,7 @@ export const meta = {
mediaOnly: {
validator: $.optional.bool,
deprecated: true,
desc: {
'ja-JP': 'true にすると、ファイルが添付された投稿だけ取得します (このパラメータは廃止予定です。代わりに withFiles を使ってください。)'
}

View File

@ -105,6 +105,7 @@ export const meta = {
mediaOnly: {
validator: $.optional.bool,
default: false,
deprecated: true,
desc: {
'ja-JP': 'true にすると、ファイルが添付された投稿だけ取得します (このパラメータは廃止予定です。代わりに withFiles を使ってください。)'
}