summaryrefslogtreecommitdiff
path: root/src/server/api/endpoints/antennas
diff options
context:
space:
mode:
authorsyuilo <Syuilotan@yahoo.co.jp>2021-03-06 22:34:51 +0900
committersyuilo <Syuilotan@yahoo.co.jp>2021-03-06 22:34:51 +0900
commitdeda2b2782e37c925c67f730e4dd8770d4ef3034 (patch)
treeb6cfb688d446f85078cfaa819f463ac10488aec1 /src/server/api/endpoints/antennas
parentfix bug (diff)
parentAPIドキュメントの改善 (#6757) (diff)
downloadsharkey-deda2b2782e37c925c67f730e4dd8770d4ef3034.tar.gz
sharkey-deda2b2782e37c925c67f730e4dd8770d4ef3034.tar.bz2
sharkey-deda2b2782e37c925c67f730e4dd8770d4ef3034.zip
Merge branch 'develop' of https://github.com/syuilo/misskey into develop
Diffstat (limited to 'src/server/api/endpoints/antennas')
-rw-r--r--src/server/api/endpoints/antennas/create.ts11
-rw-r--r--src/server/api/endpoints/antennas/delete.ts5
-rw-r--r--src/server/api/endpoints/antennas/list.ts15
-rw-r--r--src/server/api/endpoints/antennas/notes.ts15
-rw-r--r--src/server/api/endpoints/antennas/show.ts11
-rw-r--r--src/server/api/endpoints/antennas/update.ts11
6 files changed, 68 insertions, 0 deletions
diff --git a/src/server/api/endpoints/antennas/create.ts b/src/server/api/endpoints/antennas/create.ts
index bc79385260..b5f0eead2a 100644
--- a/src/server/api/endpoints/antennas/create.ts
+++ b/src/server/api/endpoints/antennas/create.ts
@@ -6,6 +6,11 @@ import { ID } from '../../../../misc/cafy-id';
import { ApiError } from '../../error';
export const meta = {
+ desc: {
+ 'ja-JP': 'アンテナを作成します。',
+ 'en-US': 'Create a antenna.'
+ },
+
tags: ['antennas'],
requireCredential: true as const,
@@ -70,6 +75,12 @@ export const meta = {
code: 'NO_SUCH_USER_GROUP',
id: 'aa3c0b9a-8cae-47c0-92ac-202ce5906682'
}
+ },
+
+ res: {
+ type: 'object' as const,
+ optional: false as const, nullable: false as const,
+ ref: 'Antenna'
}
};
diff --git a/src/server/api/endpoints/antennas/delete.ts b/src/server/api/endpoints/antennas/delete.ts
index 087834a7bd..9008c37c8e 100644
--- a/src/server/api/endpoints/antennas/delete.ts
+++ b/src/server/api/endpoints/antennas/delete.ts
@@ -5,6 +5,11 @@ import { ApiError } from '../../error';
import { Antennas } from '../../../../models';
export const meta = {
+ desc: {
+ 'ja-JP': 'アンテナを削除します。',
+ 'en-US': 'Delete a antenna.'
+ },
+
tags: ['antennas'],
requireCredential: true as const,
diff --git a/src/server/api/endpoints/antennas/list.ts b/src/server/api/endpoints/antennas/list.ts
index cbc4e827b9..bc9685887f 100644
--- a/src/server/api/endpoints/antennas/list.ts
+++ b/src/server/api/endpoints/antennas/list.ts
@@ -2,11 +2,26 @@ import define from '../../define';
import { Antennas } from '../../../../models';
export const meta = {
+ desc: {
+ 'ja-JP': 'アンテナの一覧を取得します。',
+ 'en-US': 'Get a list of antennas.'
+ },
+
tags: ['antennas', 'account'],
requireCredential: true as const,
kind: 'read:account',
+
+ res: {
+ type: 'array' as const,
+ optional: false as const, nullable: false as const,
+ items: {
+ type: 'object' as const,
+ optional: false as const, nullable: false as const,
+ ref: 'Antenna'
+ }
+ }
};
export default define(meta, async (ps, me) => {
diff --git a/src/server/api/endpoints/antennas/notes.ts b/src/server/api/endpoints/antennas/notes.ts
index 402a2758bb..750fc080cf 100644
--- a/src/server/api/endpoints/antennas/notes.ts
+++ b/src/server/api/endpoints/antennas/notes.ts
@@ -8,6 +8,11 @@ import { generateMutedUserQuery } from '../../common/generate-muted-user-query';
import { ApiError } from '../../error';
export const meta = {
+ desc: {
+ 'ja-JP': '指定したアンテナのノート一覧を表示します。',
+ 'en-US': 'Displays a list of notes for the specified antenna.'
+ },
+
tags: ['antennas', 'account', 'notes'],
requireCredential: true as const,
@@ -39,6 +44,16 @@ export const meta = {
code: 'NO_SUCH_ANTENNA',
id: '850926e0-fd3b-49b6-b69a-b28a5dbd82fe'
}
+ },
+
+ res: {
+ type: 'array' as const,
+ optional: false as const, nullable: false as const,
+ items: {
+ type: 'object' as const,
+ optional: false as const, nullable: false as const,
+ ref: 'Note'
+ }
}
};
diff --git a/src/server/api/endpoints/antennas/show.ts b/src/server/api/endpoints/antennas/show.ts
index bc2093ba61..ed400f830c 100644
--- a/src/server/api/endpoints/antennas/show.ts
+++ b/src/server/api/endpoints/antennas/show.ts
@@ -5,6 +5,11 @@ import { ApiError } from '../../error';
import { Antennas } from '../../../../models';
export const meta = {
+ desc: {
+ 'ja-JP': '指定したアンテナの情報を取得します。',
+ 'en-US': 'Acquires the information of the specified antenna.'
+ },
+
tags: ['antennas', 'account'],
requireCredential: true as const,
@@ -23,6 +28,12 @@ export const meta = {
code: 'NO_SUCH_ANTENNA',
id: 'c06569fb-b025-4f23-b22d-1fcd20d2816b'
},
+ },
+
+ res: {
+ type: 'object' as const,
+ optional: false as const, nullable: false as const,
+ ref: 'Antenna'
}
};
diff --git a/src/server/api/endpoints/antennas/update.ts b/src/server/api/endpoints/antennas/update.ts
index b329e86ade..58f4e68c89 100644
--- a/src/server/api/endpoints/antennas/update.ts
+++ b/src/server/api/endpoints/antennas/update.ts
@@ -5,6 +5,11 @@ import { ApiError } from '../../error';
import { Antennas, UserLists, UserGroupJoinings } from '../../../../models';
export const meta = {
+ desc: {
+ 'ja-JP': 'アンテナの情報を更新します。',
+ 'en-US': 'Updates the information of the specified antenna.'
+ },
+
tags: ['antennas'],
requireCredential: true as const,
@@ -79,6 +84,12 @@ export const meta = {
code: 'NO_SUCH_USER_GROUP',
id: '109ed789-b6eb-456e-b8a9-6059d567d385'
}
+ },
+
+ res: {
+ type: 'object' as const,
+ optional: false as const, nullable: false as const,
+ ref: 'Antenna'
}
};