Update DeviceStatusFirebaseController with improved route and API operation documentation

This commit is contained in:
faris Aljohari
2024-11-23 22:49:53 -06:00
parent 67ed5cdca1
commit 4e31b71a56

View File

@ -1,13 +1,14 @@
import { Controller, Post, Param } from '@nestjs/common';
import { ApiBearerAuth, ApiTags } from '@nestjs/swagger';
import { ApiBearerAuth, ApiOperation, ApiTags } from '@nestjs/swagger';
import { AddDeviceStatusDto } from '../dtos/add.devices-status.dto';
import { DeviceStatusFirebaseService } from '../services/devices-status.service';
import { EnableDisableStatusEnum } from '@app/common/constants/days.enum';
import { ControllerRoute } from '@app/common/constants/controller-route';
@ApiTags('Device Status Firebase Module')
@Controller({
version: EnableDisableStatusEnum.ENABLED,
path: 'device-status-firebase',
path: ControllerRoute.DEVICE_STATUS_FIREBASE.ROUTE,
})
export class DeviceStatusFirebaseController {
constructor(
@ -16,6 +17,13 @@ export class DeviceStatusFirebaseController {
@ApiBearerAuth()
@Post(':deviceTuyaUuid')
@ApiOperation({
summary:
ControllerRoute.DEVICE_STATUS_FIREBASE.ACTIONS.ADD_DEVICE_STATUS_SUMMARY,
description:
ControllerRoute.DEVICE_STATUS_FIREBASE.ACTIONS
.ADD_DEVICE_STATUS_DESCRIPTION,
})
async addDeviceStatus(
@Param('deviceTuyaUuid') deviceTuyaUuid: string,
): Promise<AddDeviceStatusDto> {