diff options
| author | syuilo <Syuilotan@yahoo.co.jp> | 2019-02-23 11:20:58 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-02-23 11:20:58 +0900 |
| commit | 52774bbe6402aee076b2e0648bd1f4764924da8a (patch) | |
| tree | a0e3f34ce6d000dd880a6a6c152e98e139076a14 /src/server/api/endpoints/drive/files | |
| parent | 投稿を削除したときにお気に入りからも削除するように (diff) | |
| download | sharkey-52774bbe6402aee076b2e0648bd1f4764924da8a.tar.gz sharkey-52774bbe6402aee076b2e0648bd1f4764924da8a.tar.bz2 sharkey-52774bbe6402aee076b2e0648bd1f4764924da8a.zip | |
Introduce OpenAPI specs (#4351)
* wip
* wip
* wip
* Update index.ts
* Update gen-openapi-spec.ts
* Update api.ja-JP.md
* Fix
* Improve doc
* Update gen-openapi-spec.ts
* Update redoc.html
* Improve doc
* Update gen-openapi-spec.ts
* Improve doc
* Update CHANGELOG.md
Diffstat (limited to 'src/server/api/endpoints/drive/files')
8 files changed, 26 insertions, 2 deletions
diff --git a/src/server/api/endpoints/drive/files/attached_notes.ts b/src/server/api/endpoints/drive/files/attached_notes.ts index 506444b183..c1d828b05a 100644 --- a/src/server/api/endpoints/drive/files/attached_notes.ts +++ b/src/server/api/endpoints/drive/files/attached_notes.ts @@ -13,6 +13,8 @@ export const meta = { 'en-US': 'Get the notes that specified file of drive attached.' }, + tags: ['drive', 'notes'], + requireCredential: true, kind: 'drive-read', diff --git a/src/server/api/endpoints/drive/files/check_existence.ts b/src/server/api/endpoints/drive/files/check_existence.ts index aafd46fb2d..12680d5419 100644 --- a/src/server/api/endpoints/drive/files/check_existence.ts +++ b/src/server/api/endpoints/drive/files/check_existence.ts @@ -8,6 +8,8 @@ export const meta = { 'en-US': 'Returns whether the file with the given MD5 hash exists in the user\'s drive.' }, + tags: ['drive'], + requireCredential: true, kind: 'drive-read', diff --git a/src/server/api/endpoints/drive/files/create.ts b/src/server/api/endpoints/drive/files/create.ts index c96e4bbf19..b2979c4888 100644 --- a/src/server/api/endpoints/drive/files/create.ts +++ b/src/server/api/endpoints/drive/files/create.ts @@ -13,6 +13,8 @@ export const meta = { 'en-US': 'Upload a file to drive.' }, + tags: ['drive'], + requireCredential: true, limit: { @@ -35,7 +37,7 @@ export const meta = { }, isSensitive: { - validator: $.optional.or($.bool, $.str), + validator: $.optional.either($.bool, $.str), default: false, transform: (v: any): boolean => v === true || v === 'true', desc: { @@ -45,7 +47,7 @@ export const meta = { }, force: { - validator: $.optional.or($.bool, $.str), + validator: $.optional.either($.bool, $.str), default: false, transform: (v: any): boolean => v === true || v === 'true', desc: { @@ -54,6 +56,10 @@ export const meta = { } }, + res: { + type: 'DriveFile', + }, + errors: { invalidFileName: { message: 'Invalid file name.', diff --git a/src/server/api/endpoints/drive/files/delete.ts b/src/server/api/endpoints/drive/files/delete.ts index 2dc493efeb..dd4e187fcd 100644 --- a/src/server/api/endpoints/drive/files/delete.ts +++ b/src/server/api/endpoints/drive/files/delete.ts @@ -14,6 +14,8 @@ export const meta = { 'en-US': 'Delete a file of drive.' }, + tags: ['drive'], + requireCredential: true, kind: 'drive-write', diff --git a/src/server/api/endpoints/drive/files/find.ts b/src/server/api/endpoints/drive/files/find.ts index 6eb909b9d0..0d4102a48f 100644 --- a/src/server/api/endpoints/drive/files/find.ts +++ b/src/server/api/endpoints/drive/files/find.ts @@ -6,6 +6,8 @@ import define from '../../../define'; export const meta = { requireCredential: true, + tags: ['drive'], + kind: 'drive-read', params: { diff --git a/src/server/api/endpoints/drive/files/show.ts b/src/server/api/endpoints/drive/files/show.ts index f844d434fe..c2442c65c4 100644 --- a/src/server/api/endpoints/drive/files/show.ts +++ b/src/server/api/endpoints/drive/files/show.ts @@ -14,6 +14,8 @@ export const meta = { 'en-US': 'Get specified file of drive.' }, + tags: ['drive'], + requireCredential: true, kind: 'drive-read', @@ -37,6 +39,10 @@ export const meta = { } }, + res: { + type: 'DriveFile', + }, + errors: { noSuchFile: { message: 'No such file.', diff --git a/src/server/api/endpoints/drive/files/update.ts b/src/server/api/endpoints/drive/files/update.ts index f24cc6bcd3..c8803bec3a 100644 --- a/src/server/api/endpoints/drive/files/update.ts +++ b/src/server/api/endpoints/drive/files/update.ts @@ -13,6 +13,8 @@ export const meta = { 'en-US': 'Update specified file of drive.' }, + tags: ['drive'], + requireCredential: true, kind: 'drive-write', diff --git a/src/server/api/endpoints/drive/files/upload_from_url.ts b/src/server/api/endpoints/drive/files/upload_from_url.ts index 8d25530ddd..93a9fa62fa 100644 --- a/src/server/api/endpoints/drive/files/upload_from_url.ts +++ b/src/server/api/endpoints/drive/files/upload_from_url.ts @@ -10,6 +10,8 @@ export const meta = { 'ja-JP': 'ドライブに指定されたURLに存在するファイルをアップロードします。' }, + tags: ['drive'], + limit: { duration: ms('1hour'), max: 60 |