Mizah/mizzkey
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove endpoint descriptions

Browse source 
#6627
This commit is contained in:
syuilo 2021-06-08 14:09:32 +09:00
parent d6267f797d
commit 6b312f755e
198 changed files with 0 additions and 1904 deletions
Download patch file Download diff file Expand all files Collapse all files

9
src/server/api/endpoints/notes/children.ts
View file

@ -8,11 +8,6 @@ import { Brackets } from 'typeorm';
import { Notes } from '../../../../models';
export const meta = {
desc: {
'ja-JP': '指定した投稿への返信/引用を取得します。',
'en-US': 'Get replies/quotes of a note.'
},
tags: ['notes'],
requireCredential: false as const,
@ -20,10 +15,6 @@ export const meta = {
params: {
noteId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID'
}
},
limit: {

9
src/server/api/endpoints/notes/conversation.ts
View file

@ -7,11 +7,6 @@ import { Note } from '../../../../models/entities/note';
import { Notes } from '../../../../models';
export const meta = {
desc: {
'ja-JP': '指定した投稿の文脈を取得します。',
'en-US': 'Show conversation of a note.'
},
tags: ['notes'],
requireCredential: false as const,
@ -19,10 +14,6 @@ export const meta = {
params: {
noteId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID'
}
},
limit: {

49
src/server/api/endpoints/notes/create.ts
View file

@ -23,10 +23,6 @@ setInterval(() => {
}, 3000);
export const meta = {
desc: {
'ja-JP': '投稿します。'
},
tags: ['notes'],
requireCredential: true as const,
@ -42,16 +38,10 @@ export const meta = {
visibility: {
validator: $.optional.str.or(noteVisibilities as unknown as string[]),
default: 'public',
desc: {
'ja-JP': '投稿の公開範囲'
}
},
visibleUserIds: {
validator: $.optional.arr($.type(ID)).unique().min(0),
desc: {
'ja-JP': '(投稿の公開範囲が specified の場合)投稿を閲覧できるユーザー'
}
},
text: {
@ -61,92 +51,56 @@ export const meta = {
&& Array.from(text.trim()).length <= DB_MAX_NOTE_TEXT_LENGTH // DB limit
),
default: null as any,
desc: {
'ja-JP': '投稿内容'
}
},
cw: {
validator: $.optional.nullable.str.pipe(Notes.validateCw),
desc: {
'ja-JP': 'コンテンツの警告。このパラメータを指定すると設定したテキストで投稿のコンテンツを隠す事が出来ます。'
}
},
viaMobile: {
validator: $.optional.bool,
default: false,
desc: {
'ja-JP': 'モバイルデバイスからの投稿か否か。'
}
},
localOnly: {
validator: $.optional.bool,
default: false,
desc: {
'ja-JP': 'ローカルのみに投稿か否か。'
}
},
noExtractMentions: {
validator: $.optional.bool,
default: false,
desc: {
'ja-JP': '本文からメンションを展開しないか否か。'
}
},
noExtractHashtags: {
validator: $.optional.bool,
default: false,
desc: {
'ja-JP': '本文からハッシュタグを展開しないか否か。'
}
},
noExtractEmojis: {
validator: $.optional.bool,
default: false,
desc: {
'ja-JP': '本文からカスタム絵文字を展開しないか否か。'
}
},
fileIds: {
validator: $.optional.arr($.type(ID)).unique().range(1, 4),
desc: {
'ja-JP': '添付するファイル'
}
},
mediaIds: {
validator: $.optional.arr($.type(ID)).unique().range(1, 4),
deprecated: true,
desc: {
'ja-JP': '添付するファイル (このパラメータは廃止予定です。代わりに fileIds を使ってください。)'
}
},
replyId: {
validator: $.optional.nullable.type(ID),
desc: {
'ja-JP': '返信対象'
}
},
renoteId: {
validator: $.optional.nullable.type(ID),
desc: {
'ja-JP': 'Renote対象'
}
},
channelId: {
validator: $.optional.nullable.type(ID),
desc: {
'ja-JP': 'チャンネル'
}
},
poll: {
@ -159,9 +113,6 @@ export const meta = {
expiresAt: $.optional.nullable.num.int(),
expiredAfter: $.optional.nullable.num.int().min(1)
}).strict(),
desc: {
'ja-JP': 'アンケート'
},
ref: 'poll'
}
},

9
src/server/api/endpoints/notes/delete.ts
View file

@ -8,11 +8,6 @@ import { ApiError } from '../../error';
import { Users } from '../../../../models';
export const meta = {
desc: {
'ja-JP': '指定した投稿を削除します。',
'en-US': 'Delete a note.'
},
tags: ['notes'],
requireCredential: true as const,
@ -28,10 +23,6 @@ export const meta = {
params: {
noteId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID.'
}
}
},

9
src/server/api/endpoints/notes/favorites/create.ts
View file

@ -7,11 +7,6 @@ import { NoteFavorites } from '../../../../../models';
import { genId } from '@/misc/gen-id';
export const meta = {
desc: {
'ja-JP': '指定した投稿をお気に入りに登録します。',
'en-US': 'Favorite a note.'
},
tags: ['notes', 'favorites'],
requireCredential: true as const,
@ -21,10 +16,6 @@ export const meta = {
params: {
noteId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID.'
}
}
},

9
src/server/api/endpoints/notes/favorites/delete.ts
View file

@ -6,11 +6,6 @@ import { getNote } from '../../../common/getters';
import { NoteFavorites } from '../../../../../models';
export const meta = {
desc: {
'ja-JP': '指定した投稿のお気に入りを解除します。',
'en-US': 'Unfavorite a note.'
},
tags: ['notes', 'favorites'],
requireCredential: true as const,
@ -20,10 +15,6 @@ export const meta = {
params: {
noteId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID.'
}
}
},

8
src/server/api/endpoints/notes/featured.ts
View file

@ -4,11 +4,6 @@ import { generateMutedUserQuery } from '../../common/generate-muted-user-query';
import { Notes } from '../../../../models';
export const meta = {
desc: {
'ja-JP': 'Featuredな投稿を取得します。',
'en-US': 'Get featured notes.'
},
tags: ['notes'],
requireCredential: false as const,
@ -17,9 +12,6 @@ export const meta = {
limit: {
validator: $.optional.num.range(1, 100),
default: 10,
desc: {
'ja-JP': '最大数'
}
},
offset: {

7
src/server/api/endpoints/notes/global-timeline.ts
View file

@ -11,18 +11,11 @@ import { generateRepliesQuery } from '../../common/generate-replies-query';
import { generateMutedNoteQuery } from '../../common/generate-muted-note-query';
export const meta = {
desc: {
'ja-JP': 'グローバルタイムラインを取得します。'
},
tags: ['notes'],
params: {
withFiles: {
validator: $.optional.bool,
desc: {
'ja-JP': 'ファイルが添付された投稿に限定するか否か'
}
},
limit: {

31
src/server/api/endpoints/notes/hybrid-timeline.ts
View file

@ -14,10 +14,6 @@ import { generateMutedNoteQuery } from '../../common/generate-muted-note-query';
import { generateChannelQuery } from '../../common/generate-channel-query';
export const meta = {
desc: {
'ja-JP': 'ソーシャルタイムラインを取得します。'
},
tags: ['notes'],
requireCredential: true as const,
@ -26,68 +22,41 @@ export const meta = {
limit: {
validator: $.optional.num.range(1, 100),
default: 10,
desc: {
'ja-JP': '最大数'
}
},
sinceId: {
validator: $.optional.type(ID),
desc: {
'ja-JP': '指定すると、その投稿を基点としてより新しい投稿を取得します'
}
},
untilId: {
validator: $.optional.type(ID),
desc: {
'ja-JP': '指定すると、その投稿を基点としてより古い投稿を取得します'
}
},
sinceDate: {
validator: $.optional.num,
desc: {
'ja-JP': '指定した時間を基点としてより新しい投稿を取得します。数値は、1970年1月1日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。'
}
},
untilDate: {
validator: $.optional.num,
desc: {
'ja-JP': '指定した時間を基点としてより古い投稿を取得します。数値は、1970年1月1日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。'
}
},
includeMyRenotes: {
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': '自分の行ったRenoteを含めるかどうか'
}
},
includeRenotedMyNotes: {
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': 'Renoteされた自分の投稿を含めるかどうか'
}
},
includeLocalRenotes: {
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': 'Renoteされたローカルの投稿を含めるかどうか'
}
},
withFiles: {
validator: $.optional.bool,
desc: {
'ja-JP': 'true にすると、ファイルが添付された投稿だけ取得します'
}
},
},

13
src/server/api/endpoints/notes/local-timeline.ts
View file

@ -14,33 +14,20 @@ import { generateMutedNoteQuery } from '../../common/generate-muted-note-query';
import { generateChannelQuery } from '../../common/generate-channel-query';
export const meta = {
desc: {
'ja-JP': 'ローカルタイムラインを取得します。'
},
tags: ['notes'],
params: {
withFiles: {
validator: $.optional.bool,
desc: {
'ja-JP': 'ファイルが添付された投稿に限定するか否か'
}
},
fileType: {
validator: $.optional.arr($.str),
desc: {
'ja-JP': '指定された種類のファイルが添付された投稿のみを取得します'
}
},
excludeNsfw: {
validator: $.optional.bool,
default: false,
desc: {
'ja-JP': 'true にすると、NSFW指定されたファイルを除外します(fileTypeが指定されている場合のみ有効)'
}
},
limit: {

5
src/server/api/endpoints/notes/mentions.ts
View file

@ -9,11 +9,6 @@ import { makePaginationQuery } from '../../common/make-pagination-query';
import { Brackets } from 'typeorm';
export const meta = {
desc: {
'ja-JP': '自分に言及している投稿の一覧を取得します。',
'en-US': 'Get mentions of myself.'
},
tags: ['notes'],
requireCredential: true as const,

5
src/server/api/endpoints/notes/polls/recommendation.ts
View file

@ -4,11 +4,6 @@ import { Polls, Mutings, Notes, PollVotes } from '../../../../../models';
import { Brackets, In } from 'typeorm';
export const meta = {
desc: {
'ja-JP': 'おすすめのアンケート一覧を取得します。',
'en-US': 'Get recommended polls.'
},
tags: ['notes'],
requireCredential: true as const,

9
src/server/api/endpoints/notes/polls/vote.ts
View file

@ -15,11 +15,6 @@ import { IRemoteUser } from '../../../../../models/entities/user';
import { genId } from '@/misc/gen-id';
export const meta = {
desc: {
'ja-JP': '指定した投稿のアンケートに投票します。',
'en-US': 'Vote poll of a note.'
},
tags: ['notes'],
requireCredential: true as const,
@ -29,10 +24,6 @@ export const meta = {
params: {
noteId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID'
}
},
choice: {

9
src/server/api/endpoints/notes/reactions.ts
View file

@ -8,11 +8,6 @@ import { DeepPartial } from 'typeorm';
import { NoteReaction } from '../../../../models/entities/note-reaction';
export const meta = {
desc: {
'ja-JP': '指定した投稿のリアクション一覧を取得します。',
'en-US': 'Show reactions of a note.'
},
tags: ['notes', 'reactions'],
requireCredential: false as const,
@ -20,10 +15,6 @@ export const meta = {
params: {
noteId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'The ID of the target note'
}
},
type: {

11
src/server/api/endpoints/notes/reactions/create.ts
View file

@ -6,11 +6,6 @@ import { getNote } from '../../../common/getters';
import { ApiError } from '../../../error';
export const meta = {
desc: {
'ja-JP': '指定した投稿にリアクションします。',
'en-US': 'React to a note.'
},
tags: ['reactions', 'notes'],
requireCredential: true as const,
@ -20,16 +15,10 @@ export const meta = {
params: {
noteId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象の投稿'
}
},
reaction: {
validator: $.str,
desc: {
'ja-JP': 'リアクションの種類'
}
}
},

9
src/server/api/endpoints/notes/reactions/delete.ts
View file

@ -7,11 +7,6 @@ import { getNote } from '../../../common/getters';
import { ApiError } from '../../../error';
export const meta = {
desc: {
'ja-JP': '指定した投稿へのリアクションを取り消します。',
'en-US': 'Unreact to a note.'
},
tags: ['reactions', 'notes'],
requireCredential: true as const,
@ -27,10 +22,6 @@ export const meta = {
params: {
noteId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID'
}
},
},

9
src/server/api/endpoints/notes/renotes.ts
View file

@ -9,11 +9,6 @@ import { makePaginationQuery } from '../../common/make-pagination-query';
import { Notes } from '../../../../models';
export const meta = {
desc: {
'ja-JP': '指定した投稿のRenote一覧を取得します。',
'en-US': 'Show a renotes of a note.'
},
tags: ['notes'],
requireCredential: false as const,
@ -21,10 +16,6 @@ export const meta = {
params: {
noteId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID'
}
},
limit: {

15
src/server/api/endpoints/notes/replies.ts
View file

@ -7,11 +7,6 @@ import { generateVisibilityQuery } from '../../common/generate-visibility-query'
import { generateMutedUserQuery } from '../../common/generate-muted-user-query';
export const meta = {
desc: {
'ja-JP': '指定した投稿への返信を取得します。',
'en-US': 'Get replies of a note.'
},
tags: ['notes'],
requireCredential: false as const,
@ -19,24 +14,14 @@ export const meta = {
params: {
noteId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID'
}
},
sinceId: {
validator: $.optional.type(ID),
desc: {
'ja-JP': '指定すると、その投稿を基点としてより新しい投稿を取得します'
}
},
untilId: {
validator: $.optional.type(ID),
desc: {
'ja-JP': '指定すると、その投稿を基点としてより古い投稿を取得します'
}
},
limit: {

28
src/server/api/endpoints/notes/search-by-tag.ts
View file

@ -10,70 +10,42 @@ import { safeForSql } from '@/misc/safe-for-sql';
import { normalizeForSearch } from '@/misc/normalize-for-search';
export const meta = {
desc: {
'ja-JP': '指定されたタグが付けられた投稿を取得します。'
},
tags: ['notes', 'hashtags'],
params: {
tag: {
validator: $.optional.str,
desc: {
'ja-JP': 'タグ'
}
},
query: {
validator: $.optional.arr($.arr($.str)),
desc: {
'ja-JP': 'クエリ'
}
},
reply: {
validator: $.optional.nullable.bool,
default: null as any,
desc: {
'ja-JP': '返信に限定するか否か'
}
},
renote: {
validator: $.optional.nullable.bool,
default: null as any,
desc: {
'ja-JP': 'Renoteに限定するか否か'
}
},
withFiles: {
validator: $.optional.bool,
desc: {
'ja-JP': 'true にすると、ファイルが添付された投稿だけ取得します'
}
},
poll: {
validator: $.optional.nullable.bool,
default: null as any,
desc: {
'ja-JP': 'アンケートが添付された投稿に限定するか否か'
}
},
sinceId: {
validator: $.optional.type(ID),
desc: {
'ja-JP': '指定すると、その投稿を基点としてより新しい投稿を取得します'
}
},
untilId: {
validator: $.optional.type(ID),
desc: {
'ja-JP': '指定すると、その投稿を基点としてより古い投稿を取得します'
}
},
limit: {

5
src/server/api/endpoints/notes/search.ts
View file

@ -10,11 +10,6 @@ import { generateVisibilityQuery } from '../../common/generate-visibility-query'
import { generateMutedUserQuery } from '../../common/generate-muted-user-query';
export const meta = {
desc: {
'ja-JP': '投稿を検索します。',
'en-US': 'Search notes.'
},
tags: ['notes'],
requireCredential: false as const,

9
src/server/api/endpoints/notes/show.ts
View file

@ -6,11 +6,6 @@ import { ApiError } from '../../error';
import { Notes } from '../../../../models';
export const meta = {
desc: {
'ja-JP': '指定した投稿を取得します。',
'en-US': 'Get a note.'
},
tags: ['notes'],
requireCredential: false as const,
@ -18,10 +13,6 @@ export const meta = {
params: {
noteId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID.'
}
}
},

9
src/server/api/endpoints/notes/state.ts
View file

@ -4,11 +4,6 @@ import define from '../../define';
import { NoteFavorites, NoteWatchings } from '../../../../models';
export const meta = {
desc: {
'ja-JP': '指定した投稿の状態を取得します。',
'en-US': 'Get state of a note.'
},
tags: ['notes'],
requireCredential: true as const,
@ -16,10 +11,6 @@ export const meta = {
params: {
noteId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID.'
}
}
},

32
src/server/api/endpoints/notes/timeline.ts
View file

@ -12,11 +12,6 @@ import { generateMutedNoteQuery } from '../../common/generate-muted-note-query';
import { generateChannelQuery } from '../../common/generate-channel-query';
export const meta = {
desc: {
'ja-JP': 'タイムラインを取得します。',
'en-US': 'Get timeline of myself.'
},
tags: ['notes'],
requireCredential: true as const,
@ -25,68 +20,41 @@ export const meta = {
limit: {
validator: $.optional.num.range(1, 100),
default: 10,
desc: {
'ja-JP': '最大数'
}
},
sinceId: {
validator: $.optional.type(ID),
desc: {
'ja-JP': '指定すると、その投稿を基点としてより新しい投稿を取得します'
}
},
untilId: {
validator: $.optional.type(ID),
desc: {
'ja-JP': '指定すると、その投稿を基点としてより古い投稿を取得します'
}
},
sinceDate: {
validator: $.optional.num,
desc: {
'ja-JP': '指定した時間を基点としてより新しい投稿を取得します。数値は、1970年1月1日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。'
}
},
untilDate: {
validator: $.optional.num,
desc: {
'ja-JP': '指定した時間を基点としてより古い投稿を取得します。数値は、1970年1月1日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。'
}
},
includeMyRenotes: {
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': '自分の行ったRenoteを含めるかどうか'
}
},
includeRenotedMyNotes: {
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': 'Renoteされた自分の投稿を含めるかどうか'
}
},
includeLocalRenotes: {
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': 'Renoteされたローカルの投稿を含めるかどうか'
}
},
withFiles: {
validator: $.optional.bool,
desc: {
'ja-JP': 'true にすると、ファイルが添付された投稿だけ取得します'
}
},
},

8
src/server/api/endpoints/notes/unrenote.ts
View file

@ -8,10 +8,6 @@ import { ApiError } from '../../error';
import { Notes, Users } from '../../../../models';
export const meta = {
desc: {
'ja-JP': '指定した投稿のRenoteを解除します。',
},
tags: ['notes'],
requireCredential: true as const,
@ -27,10 +23,6 @@ export const meta = {
params: {
noteId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID.'
}
}
},

35
src/server/api/endpoints/notes/user-list-timeline.ts
View file

@ -9,11 +9,6 @@ import { activeUsersChart } from '../../../../services/chart';
import { Brackets } from 'typeorm';
export const meta = {
desc: {
'ja-JP': '指定したユーザーリストのタイムラインを取得します。',
'en-US': 'Get timeline of a user list.'
},
tags: ['notes', 'lists'],
requireCredential: true as const,
@ -21,76 +16,46 @@ export const meta = {
params: {
listId: {
validator: $.type(ID),
desc: {
'ja-JP': 'リストのID'
}
},
limit: {
validator: $.optional.num.range(1, 100),
default: 10,
desc: {
'ja-JP': '最大数'
}
},
sinceId: {
validator: $.optional.type(ID),
desc: {
'ja-JP': '指定すると、その投稿を基点としてより新しい投稿を取得します'
}
},
untilId: {
validator: $.optional.type(ID),
desc: {
'ja-JP': '指定すると、その投稿を基点としてより古い投稿を取得します'
}
},
sinceDate: {
validator: $.optional.num,
desc: {
'ja-JP': '指定した時間を基点としてより新しい投稿を取得します。数値は、1970年1月1日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。'
}
},
untilDate: {
validator: $.optional.num,
desc: {
'ja-JP': '指定した時間を基点としてより古い投稿を取得します。数値は、1970年1月1日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。'
}
},
includeMyRenotes: {
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': '自分の行ったRenoteを含めるかどうか'
}
},
includeRenotedMyNotes: {
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': 'Renoteされた自分の投稿を含めるかどうか'
}
},
includeLocalRenotes: {
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': 'Renoteされたローカルの投稿を含めるかどうか'
}
},
withFiles: {
validator: $.optional.bool,
desc: {
'ja-JP': 'true にすると、ファイルが添付された投稿だけ取得します'
}
},
},

9
src/server/api/endpoints/notes/watching/create.ts
View file

@ -6,11 +6,6 @@ import { getNote } from '../../../common/getters';
import { ApiError } from '../../../error';
export const meta = {
desc: {
'ja-JP': '指定した投稿をウォッチします。',
'en-US': 'Watch a note.'
},
tags: ['notes'],
requireCredential: true as const,
@ -20,10 +15,6 @@ export const meta = {
params: {
noteId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID.'
}
}
},

9
src/server/api/endpoints/notes/watching/delete.ts
View file

@ -6,11 +6,6 @@ import { getNote } from '../../../common/getters';
import { ApiError } from '../../../error';
export const meta = {
desc: {
'ja-JP': '指定した投稿のウォッチを解除します。',
'en-US': 'Unwatch a note.'
},
tags: ['notes'],
requireCredential: true as const,
@ -20,10 +15,6 @@ export const meta = {
params: {
noteId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象の投稿のID',
'en-US': 'Target note ID.'
}
}
},