summaryrefslogtreecommitdiff
path: root/src/api/endpoints.ts
diff options
context:
space:
mode:
authorAkihiko Odaki <nekomanma@pixiv.co.jp>2018-03-29 01:20:40 +0900
committerAkihiko Odaki <nekomanma@pixiv.co.jp>2018-03-29 01:54:41 +0900
commit90f8fe7e538bb7e52d2558152a0390e693f39b11 (patch)
tree0f830887053c8f352b1cd0c13ca715fd14c1f030 /src/api/endpoints.ts
parentImplement remote account resolution (diff)
downloadsharkey-90f8fe7e538bb7e52d2558152a0390e693f39b11.tar.gz
sharkey-90f8fe7e538bb7e52d2558152a0390e693f39b11.tar.bz2
sharkey-90f8fe7e538bb7e52d2558152a0390e693f39b11.zip
Introduce processor
Diffstat (limited to 'src/api/endpoints.ts')
-rw-r--r--src/api/endpoints.ts584
1 files changed, 0 insertions, 584 deletions
diff --git a/src/api/endpoints.ts b/src/api/endpoints.ts
deleted file mode 100644
index c7100bd036..0000000000
--- a/src/api/endpoints.ts
+++ /dev/null
@@ -1,584 +0,0 @@
-const ms = require('ms');
-
-/**
- * エンドポイントを表します。
- */
-export type Endpoint = {
-
- /**
- * エンドポイント名
- */
- name: string;
-
- /**
- * このエンドポイントにリクエストするのにユーザー情報が必須か否か
- * 省略した場合は false として解釈されます。
- */
- withCredential?: boolean;
-
- /**
- * エンドポイントのリミテーションに関するやつ
- * 省略した場合はリミテーションは無いものとして解釈されます。
- * また、withCredential が false の場合はリミテーションを行うことはできません。
- */
- limit?: {
-
- /**
- * 複数のエンドポイントでリミットを共有したい場合に指定するキー
- */
- key?: string;
-
- /**
- * リミットを適用する期間(ms)
- * このプロパティを設定する場合、max プロパティも設定する必要があります。
- */
- duration?: number;
-
- /**
- * durationで指定した期間内にいくつまでリクエストできるのか
- * このプロパティを設定する場合、duration プロパティも設定する必要があります。
- */
- max?: number;
-
- /**
- * 最低でもどれくらいの間隔を開けてリクエストしなければならないか(ms)
- */
- minInterval?: number;
- };
-
- /**
- * ファイルの添付を必要とするか否か
- * 省略した場合は false として解釈されます。
- */
- withFile?: boolean;
-
- /**
- * サードパーティアプリからはリクエストすることができないか否か
- * 省略した場合は false として解釈されます。
- */
- secure?: boolean;
-
- /**
- * エンドポイントの種類
- * パーミッションの実現に利用されます。
- */
- kind?: string;
-};
-
-const endpoints: Endpoint[] = [
- {
- name: 'meta'
- },
- {
- name: 'stats'
- },
- {
- name: 'username/available'
- },
- {
- name: 'my/apps',
- withCredential: true
- },
- {
- name: 'app/create',
- withCredential: true,
- limit: {
- duration: ms('1day'),
- max: 3
- }
- },
- {
- name: 'app/show'
- },
- {
- name: 'app/name_id/available'
- },
- {
- name: 'auth/session/generate'
- },
- {
- name: 'auth/session/show'
- },
- {
- name: 'auth/session/userkey'
- },
- {
- name: 'auth/accept',
- withCredential: true,
- secure: true
- },
- {
- name: 'auth/deny',
- withCredential: true,
- secure: true
- },
- {
- name: 'aggregation/posts',
- },
- {
- name: 'aggregation/users',
- },
- {
- name: 'aggregation/users/activity',
- },
- {
- name: 'aggregation/users/post',
- },
- {
- name: 'aggregation/users/followers'
- },
- {
- name: 'aggregation/users/following'
- },
- {
- name: 'aggregation/users/reaction'
- },
- {
- name: 'aggregation/posts/repost'
- },
- {
- name: 'aggregation/posts/reply'
- },
- {
- name: 'aggregation/posts/reaction'
- },
- {
- name: 'aggregation/posts/reactions'
- },
-
- {
- name: 'sw/register',
- withCredential: true
- },
-
- {
- name: 'i',
- withCredential: true
- },
- {
- name: 'i/2fa/register',
- withCredential: true,
- secure: true
- },
- {
- name: 'i/2fa/unregister',
- withCredential: true,
- secure: true
- },
- {
- name: 'i/2fa/done',
- withCredential: true,
- secure: true
- },
- {
- name: 'i/update',
- withCredential: true,
- limit: {
- duration: ms('1day'),
- max: 50
- },
- kind: 'account-write'
- },
- {
- name: 'i/update_home',
- withCredential: true,
- secure: true
- },
- {
- name: 'i/update_mobile_home',
- withCredential: true,
- secure: true
- },
- {
- name: 'i/change_password',
- withCredential: true,
- secure: true
- },
- {
- name: 'i/regenerate_token',
- withCredential: true,
- secure: true
- },
- {
- name: 'i/update_client_setting',
- withCredential: true,
- secure: true
- },
- {
- name: 'i/pin',
- kind: 'account-write'
- },
- {
- name: 'i/appdata/get',
- withCredential: true
- },
- {
- name: 'i/appdata/set',
- withCredential: true
- },
- {
- name: 'i/signin_history',
- withCredential: true,
- kind: 'account-read'
- },
- {
- name: 'i/authorized_apps',
- withCredential: true,
- secure: true
- },
-
- {
- name: 'i/notifications',
- withCredential: true,
- kind: 'notification-read'
- },
-
- {
- name: 'othello/match',
- withCredential: true
- },
-
- {
- name: 'othello/match/cancel',
- withCredential: true
- },
-
- {
- name: 'othello/invitations',
- withCredential: true
- },
-
- {
- name: 'othello/games',
- withCredential: true
- },
-
- {
- name: 'othello/games/show'
- },
-
- {
- name: 'mute/create',
- withCredential: true,
- kind: 'account/write'
- },
- {
- name: 'mute/delete',
- withCredential: true,
- kind: 'account/write'
- },
- {
- name: 'mute/list',
- withCredential: true,
- kind: 'account/read'
- },
-
- {
- name: 'notifications/get_unread_count',
- withCredential: true,
- kind: 'notification-read'
- },
- {
- name: 'notifications/delete',
- withCredential: true,
- kind: 'notification-write'
- },
- {
- name: 'notifications/delete_all',
- withCredential: true,
- kind: 'notification-write'
- },
- {
- name: 'notifications/mark_as_read_all',
- withCredential: true,
- kind: 'notification-write'
- },
-
- {
- name: 'drive',
- withCredential: true,
- kind: 'drive-read'
- },
- {
- name: 'drive/stream',
- withCredential: true,
- kind: 'drive-read'
- },
- {
- name: 'drive/files',
- withCredential: true,
- kind: 'drive-read'
- },
- {
- name: 'drive/files/create',
- withCredential: true,
- limit: {
- duration: ms('1hour'),
- max: 100
- },
- withFile: true,
- kind: 'drive-write'
- },
- {
- name: 'drive/files/upload_from_url',
- withCredential: true,
- limit: {
- duration: ms('1hour'),
- max: 10
- },
- kind: 'drive-write'
- },
- {
- name: 'drive/files/show',
- withCredential: true,
- kind: 'drive-read'
- },
- {
- name: 'drive/files/find',
- withCredential: true,
- kind: 'drive-read'
- },
- {
- name: 'drive/files/delete',
- withCredential: true,
- kind: 'drive-write'
- },
- {
- name: 'drive/files/update',
- withCredential: true,
- kind: 'drive-write'
- },
- {
- name: 'drive/folders',
- withCredential: true,
- kind: 'drive-read'
- },
- {
- name: 'drive/folders/create',
- withCredential: true,
- limit: {
- duration: ms('1hour'),
- max: 50
- },
- kind: 'drive-write'
- },
- {
- name: 'drive/folders/show',
- withCredential: true,
- kind: 'drive-read'
- },
- {
- name: 'drive/folders/find',
- withCredential: true,
- kind: 'drive-read'
- },
- {
- name: 'drive/folders/update',
- withCredential: true,
- kind: 'drive-write'
- },
-
- {
- name: 'users'
- },
- {
- name: 'users/show'
- },
- {
- name: 'users/search'
- },
- {
- name: 'users/search_by_username'
- },
- {
- name: 'users/posts'
- },
- {
- name: 'users/following'
- },
- {
- name: 'users/followers'
- },
- {
- name: 'users/recommendation',
- withCredential: true,
- kind: 'account-read'
- },
- {
- name: 'users/get_frequently_replied_users'
- },
-
- {
- name: 'following/create',
- withCredential: true,
- limit: {
- duration: ms('1hour'),
- max: 100
- },
- kind: 'following-write'
- },
- {
- name: 'following/delete',
- withCredential: true,
- limit: {
- duration: ms('1hour'),
- max: 100
- },
- kind: 'following-write'
- },
-
- {
- name: 'posts'
- },
- {
- name: 'posts/show'
- },
- {
- name: 'posts/replies'
- },
- {
- name: 'posts/context'
- },
- {
- name: 'posts/create',
- withCredential: true,
- limit: {
- duration: ms('1hour'),
- max: 120,
- minInterval: ms('1second')
- },
- kind: 'post-write'
- },
- {
- name: 'posts/reposts'
- },
- {
- name: 'posts/search'
- },
- {
- name: 'posts/timeline',
- withCredential: true,
- limit: {
- duration: ms('10minutes'),
- max: 100
- }
- },
- {
- name: 'posts/mentions',
- withCredential: true,
- limit: {
- duration: ms('10minutes'),
- max: 100
- }
- },
- {
- name: 'posts/trend',
- withCredential: true
- },
- {
- name: 'posts/categorize',
- withCredential: true
- },
- {
- name: 'posts/reactions',
- withCredential: true
- },
- {
- name: 'posts/reactions/create',
- withCredential: true,
- limit: {
- duration: ms('1hour'),
- max: 100
- },
- kind: 'reaction-write'
- },
- {
- name: 'posts/reactions/delete',
- withCredential: true,
- limit: {
- duration: ms('1hour'),
- max: 100
- },
- kind: 'reaction-write'
- },
- {
- name: 'posts/favorites/create',
- withCredential: true,
- limit: {
- duration: ms('1hour'),
- max: 100
- },
- kind: 'favorite-write'
- },
- {
- name: 'posts/favorites/delete',
- withCredential: true,
- limit: {
- duration: ms('1hour'),
- max: 100
- },
- kind: 'favorite-write'
- },
- {
- name: 'posts/polls/vote',
- withCredential: true,
- limit: {
- duration: ms('1hour'),
- max: 100
- },
- kind: 'vote-write'
- },
- {
- name: 'posts/polls/recommendation',
- withCredential: true
- },
-
- {
- name: 'messaging/history',
- withCredential: true,
- kind: 'messaging-read'
- },
- {
- name: 'messaging/unread',
- withCredential: true,
- kind: 'messaging-read'
- },
- {
- name: 'messaging/messages',
- withCredential: true,
- kind: 'messaging-read'
- },
- {
- name: 'messaging/messages/create',
- withCredential: true,
- kind: 'messaging-write'
- },
- {
- name: 'channels/create',
- withCredential: true,
- limit: {
- duration: ms('1hour'),
- max: 3,
- minInterval: ms('10seconds')
- }
- },
- {
- name: 'channels/show'
- },
- {
- name: 'channels/posts'
- },
- {
- name: 'channels/watch',
- withCredential: true
- },
- {
- name: 'channels/unwatch',
- withCredential: true
- },
- {
- name: 'channels'
- },
-];
-
-export default endpoints;