summaryrefslogtreecommitdiff
path: root/src/server/api/endpoints/users/groups/show.ts
diff options
context:
space:
mode:
Diffstat (limited to 'src/server/api/endpoints/users/groups/show.ts')
-rw-r--r--src/server/api/endpoints/users/groups/show.ts53
1 files changed, 53 insertions, 0 deletions
diff --git a/src/server/api/endpoints/users/groups/show.ts b/src/server/api/endpoints/users/groups/show.ts
new file mode 100644
index 0000000000..5f2c839881
--- /dev/null
+++ b/src/server/api/endpoints/users/groups/show.ts
@@ -0,0 +1,53 @@
+import $ from 'cafy';
+import { ID } from '../../../../../misc/cafy-id';
+import define from '../../../define';
+import { ApiError } from '../../../error';
+import { UserGroups } from '../../../../../models';
+import { types, bool } from '../../../../../misc/schema';
+
+export const meta = {
+ desc: {
+ 'ja-JP': '指定したユーザーグループの情報を取得します。',
+ 'en-US': 'Show a user group.'
+ },
+
+ tags: ['groups', 'account'],
+
+ requireCredential: true,
+
+ kind: 'read:user-groups',
+
+ params: {
+ groupId: {
+ validator: $.type(ID),
+ },
+ },
+
+ res: {
+ type: types.object,
+ optional: bool.false, nullable: bool.false,
+ ref: 'UserGroup',
+ },
+
+ errors: {
+ noSuchGroup: {
+ message: 'No such group.',
+ code: 'NO_SUCH_GROUP',
+ id: 'ea04751e-9b7e-487b-a509-330fb6bd6b9b'
+ },
+ }
+};
+
+export default define(meta, async (ps, me) => {
+ // Fetch the group
+ const userGroup = await UserGroups.findOne({
+ id: ps.groupId,
+ userId: me.id,
+ });
+
+ if (userGroup == null) {
+ throw new ApiError(meta.errors.noSuchGroup);
+ }
+
+ return await UserGroups.pack(userGroup);
+});