feat(api/private): add GroupsController

The GroupsController can be used to fetch information about groups.

Signed-off-by: David Mehren <git@herrmehren.de>

src/api/private/groups/groups.controller.ts

@@ -0,0 +1,34 @@
+/*
+ * SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+import { Controller, Get, Param, UseGuards } from '@nestjs/common';
+import { ApiTags } from '@nestjs/swagger';
+
+import { GroupInfoDto } from '../../../groups/group-info.dto';
+import { GroupsService } from '../../../groups/groups.service';
+import { SessionGuard } from '../../../identity/session.guard';
+import { ConsoleLoggerService } from '../../../logger/console-logger.service';
+import { OpenApi } from '../../utils/openapi.decorator';
+
+@UseGuards(SessionGuard)
+@OpenApi(401, 403)
+@ApiTags('groups')
+@Controller('groups')
+export class GroupsController {
+  constructor(
+    private readonly logger: ConsoleLoggerService,
+    private groupService: GroupsService,
+  ) {
+    this.logger.setContext(GroupsController.name);
+  }
+
+  @Get(':groupName')
+  @OpenApi(200)
+  async getGroup(@Param('groupName') groupName: string): Promise<GroupInfoDto> {
+    return this.groupService.toGroupDto(
+      await this.groupService.getGroupByName(groupName),
+    );
+  }
+}

src/api/private/private-api.module.ts

@@ -7,6 +7,7 @@ import { Module } from '@nestjs/common';
 
 import { AuthModule } from '../../auth/auth.module';
 import { FrontendConfigModule } from '../../frontend-config/frontend-config.module';
+import { GroupsModule } from '../../groups/groups.module';
 import { HistoryModule } from '../../history/history.module';
 import { IdentityModule } from '../../identity/identity.module';
 import { LoggerModule } from '../../logger/logger.module';
@@ -18,6 +19,7 @@ import { UsersModule } from '../../users/users.module';
 import { AliasController } from './alias/alias.controller';
 import { AuthController } from './auth/auth.controller';
 import { ConfigController } from './config/config.controller';
+import { GroupsController } from './groups/groups.controller';
 import { HistoryController } from './me/history/history.controller';
 import { MeController } from './me/me.controller';
 import { MediaController } from './media/media.controller';
@@ -37,6 +39,7 @@ import { UsersController } from './users/users.controller';
     MediaModule,
     RevisionsModule,
     IdentityModule,
+    GroupsModule,
   ],
   controllers: [
     TokensController,
@@ -48,7 +51,7 @@ import { UsersController } from './users/users.controller';
     AliasController,
     AuthController,
     UsersController,
-    GroupController,
+    GroupsController,
   ],
 })
 export class PrivateApiModule {}