ammar/backend
1
0
Fork 0
mirror of https://github.com/SyncrowIOT/backend.git synced 2026-10-26 01:27:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor GroupController to use static route constants and add API operation descriptions

Browse Source
This commit is contained in:
faris Aljohari
2024-11-23 22:50:52 -06:00
parent 059d248d44
commit 19c7233836
1 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/group/controllers/group.controller.ts
+14 -2
View File
@@ -1,13 +1,14 @@
import { GroupService } from '../services/group.service';
import { Controller, Get, UseGuards, Param, Req } from '@nestjs/common';
import { ApiTags, ApiBearerAuth } from '@nestjs/swagger';
import { ApiTags, ApiBearerAuth, ApiOperation } from '@nestjs/swagger';
import { JwtAuthGuard } from '@app/common/guards/jwt.auth.guard';
import { EnableDisableStatusEnum } from '@app/common/constants/days.enum';
import { ControllerRoute } from '@app/common/constants/controller-route'; // Assuming this is where the routes are defined
@ApiTags('Group Module')
@Controller({
version: EnableDisableStatusEnum.ENABLED,
path: 'group',
path: ControllerRoute.GROUP.ROUTE, // use the static route constant
})
export class GroupController {
constructor(private readonly groupService: GroupService) {}
@@ -15,6 +16,11 @@ export class GroupController {
@ApiBearerAuth()
@UseGuards(JwtAuthGuard)
@Get(':spaceUuid')
@ApiOperation({
summary: ControllerRoute.GROUP.ACTIONS.GET_GROUPS_BY_SPACE_UUID_SUMMARY,
description:
ControllerRoute.GROUP.ACTIONS.GET_GROUPS_BY_SPACE_UUID_DESCRIPTION,
})
async getGroupsBySpaceUuid(@Param('spaceUuid') spaceUuid: string) {
return await this.groupService.getGroupsBySpaceUuid(spaceUuid);
}
@@ -22,6 +28,12 @@ export class GroupController {
@ApiBearerAuth()
@UseGuards(JwtAuthGuard)
@Get(':spaceUuid/devices/:groupName')
@ApiOperation({
summary:
ControllerRoute.GROUP.ACTIONS.GET_UNIT_DEVICES_BY_GROUP_NAME_SUMMARY,
description:
ControllerRoute.GROUP.ACTIONS.GET_UNIT_DEVICES_BY_GROUP_NAME_DESCRIPTION,
})
async getUnitDevicesByGroupName(
@Param('spaceUuid') spaceUuid: string,
@Param('groupName') groupName: string,