Improve doc

11 files changed, 38 insertions, 0 deletions

diff --git a/src/server/api/endpoints/auth/session/generate.ts b/src/server/api/endpoints/auth/session/generate.ts
index ddbd7209c9..e12bea7681 100644
--- a/src/server/api/endpoints/auth/session/generate.ts
+++ b/src/server/api/endpoints/auth/session/generate.ts
@@ -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.',
diff --git a/src/server/api/endpoints/auth/session/userkey.ts b/src/server/api/endpoints/auth/session/userkey.ts
index 49dde23ede..e09e16e658 100644
--- a/src/server/api/endpoints/auth/session/userkey.ts
+++ b/src/server/api/endpoints/auth/session/userkey.ts
@@ -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.',
diff --git a/src/server/api/endpoints/notes.ts b/src/server/api/endpoints/notes.ts
index 8283e92bfe..835c515cfe 100644
--- a/src/server/api/endpoints/notes.ts
+++ b/src/server/api/endpoints/notes.ts
@@ -41,6 +41,7 @@ export const meta = {
 
 		media: {
 			validator: $.optional.bool,
+			deprecated: true,
 			desc: {
 				'ja-JP': 'ファイルが添付された投稿に限定するか否か (このパラメータは廃止予定です。代わりに withFiles を使ってください。)'
 			}
diff --git a/src/server/api/endpoints/notes/create.ts b/src/server/api/endpoints/notes/create.ts
index 7df86625d6..bb0d8f94f5 100644
--- a/src/server/api/endpoints/notes/create.ts
+++ b/src/server/api/endpoints/notes/create.ts
@@ -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 を使ってください。)'
 			}
diff --git a/src/server/api/endpoints/notes/global-timeline.ts b/src/server/api/endpoints/notes/global-timeline.ts
index b62d8e25a3..0eb761cdb6 100644
--- a/src/server/api/endpoints/notes/global-timeline.ts
+++ b/src/server/api/endpoints/notes/global-timeline.ts
@@ -24,6 +24,7 @@ export const meta = {
 
 		mediaOnly: {
 			validator: $.optional.bool,
+			deprecated: true,
 			desc: {
 				'ja-JP': 'ファイルが添付された投稿に限定するか否か (このパラメータは廃止予定です。代わりに withFiles を使ってください。)'
 			}
diff --git a/src/server/api/endpoints/notes/hybrid-timeline.ts b/src/server/api/endpoints/notes/hybrid-timeline.ts
index 153436b9bb..9695547f04 100644
--- a/src/server/api/endpoints/notes/hybrid-timeline.ts
+++ b/src/server/api/endpoints/notes/hybrid-timeline.ts
@@ -88,6 +88,7 @@ export const meta = {
 
 		mediaOnly: {
 			validator: $.optional.bool,
+			deprecated: true,
 			desc: {
 				'ja-JP': 'true にすると、ファイルが添付された投稿だけ取得します (このパラメータは廃止予定です。代わりに withFiles を使ってください。)'
 			}
diff --git a/src/server/api/endpoints/notes/local-timeline.ts b/src/server/api/endpoints/notes/local-timeline.ts
index 06c6d7a533..57ef4c3e15 100644
--- a/src/server/api/endpoints/notes/local-timeline.ts
+++ b/src/server/api/endpoints/notes/local-timeline.ts
@@ -25,6 +25,7 @@ export const meta = {
 
 		mediaOnly: {
 			validator: $.optional.bool,
+			deprecated: true,
 			desc: {
 				'ja-JP': 'ファイルが添付された投稿に限定するか否か (このパラメータは廃止予定です。代わりに withFiles を使ってください。)'
 			}
diff --git a/src/server/api/endpoints/notes/search-by-tag.ts b/src/server/api/endpoints/notes/search-by-tag.ts
index 0030e2e37a..b33c884049 100644
--- a/src/server/api/endpoints/notes/search-by-tag.ts
+++ b/src/server/api/endpoints/notes/search-by-tag.ts
@@ -64,6 +64,7 @@ export const meta = {
 		media: {
 			validator: $.optional.nullable.bool,
 			default: null as any,
+			deprecated: true,
 			desc: {
 				'ja-JP': 'ファイルが添付された投稿に限定するか否か (このパラメータは廃止予定です。代わりに withFiles を使ってください。)'
 			}
diff --git a/src/server/api/endpoints/notes/timeline.ts b/src/server/api/endpoints/notes/timeline.ts
index 9ec8070f71..6ff7690c74 100644
--- a/src/server/api/endpoints/notes/timeline.ts
+++ b/src/server/api/endpoints/notes/timeline.ts
@@ -89,6 +89,7 @@ export const meta = {
 
 		mediaOnly: {
 			validator: $.optional.bool,
+			deprecated: true,
 			desc: {
 				'ja-JP': 'true にすると、ファイルが添付された投稿だけ取得します (このパラメータは廃止予定です。代わりに withFiles を使ってください。)'
 			}
diff --git a/src/server/api/endpoints/notes/user-list-timeline.ts b/src/server/api/endpoints/notes/user-list-timeline.ts
index 45e96fbdac..17c24ab119 100644
--- a/src/server/api/endpoints/notes/user-list-timeline.ts
+++ b/src/server/api/endpoints/notes/user-list-timeline.ts
@@ -98,6 +98,7 @@ export const meta = {
 
 		mediaOnly: {
 			validator: $.optional.bool,
+			deprecated: true,
 			desc: {
 				'ja-JP': 'true にすると、ファイルが添付された投稿だけ取得します (このパラメータは廃止予定です。代わりに withFiles を使ってください。)'
 			}
diff --git a/src/server/api/endpoints/users/notes.ts b/src/server/api/endpoints/users/notes.ts
index f8942fb2d3..10d2f37fc2 100644
--- a/src/server/api/endpoints/users/notes.ts
+++ b/src/server/api/endpoints/users/notes.ts
@@ -105,6 +105,7 @@ export const meta = {
 		mediaOnly: {
 			validator: $.optional.bool,
 			default: false,
+			deprecated: true,
 			desc: {
 				'ja-JP': 'true にすると、ファイルが添付された投稿だけ取得します (このパラメータは廃止予定です。代わりに withFiles を使ってください。)'
 			}