Spaces:
Sleeping
Sleeping
| import { | |
| Controller, | |
| Get, | |
| Post, | |
| Put, | |
| Delete, | |
| Param, | |
| Body, | |
| Query, | |
| UseGuards, | |
| HttpCode, | |
| ParseIntPipe, | |
| } from '@nestjs/common'; | |
| import { | |
| ApiTags, | |
| ApiOperation, | |
| ApiResponse, | |
| ApiBearerAuth, | |
| ApiParam, | |
| ApiQuery, | |
| ApiBody, | |
| } from '@nestjs/swagger'; | |
| import { CampusService } from '../services/campus.service'; | |
| import { | |
| CreateCampusDto, | |
| UpdateCampusDto, | |
| CampusDto, | |
| } from '../dtos/campus.dto'; | |
| import { Status } from '../enums/status.enum'; | |
| import { JwtAuthGuard } from '../../auth/guards/jwt-auth.guard'; | |
| import { RolesGuard } from '../../auth/guards/roles.guard'; | |
| import { Roles } from '../../auth/roles.decorator'; | |
| import { RoleName } from '../../auth/entities/role.entity'; | |
| ('🏛️ Campus') | |
| ('api/campuses') | |
| (JwtAuthGuard, RolesGuard) | |
| ('JWT-auth') | |
| export class CampusController { | |
| constructor(private readonly campusService: CampusService) {} | |
| () | |
| ( | |
| RoleName.IT_ADMIN, | |
| RoleName.ADMIN, | |
| RoleName.INSTRUCTOR, | |
| RoleName.TA, | |
| RoleName.STUDENT, | |
| ) | |
| ({ | |
| summary: 'List all campuses', | |
| description: ` | |
| ## List All Campuses | |
| Retrieves all campuses in the system with optional status filter. | |
| ### Access Control | |
| - **Authentication Required**: ✅ Yes (Bearer Token) | |
| - **Roles Required**: All roles (STUDENT, INSTRUCTOR, TA, ADMIN, IT_ADMIN) | |
| ### Filtering | |
| Use the \`status\` query parameter to filter by campus status. | |
| `, | |
| }) | |
| ({ | |
| name: 'status', | |
| required: false, | |
| description: 'Filter by status', | |
| type: String, | |
| schema: { type: 'string', enum: Object.values(Status) }, | |
| }) | |
| ({ status: 200, description: 'List of campuses' }) | |
| ({ status: 401, description: 'Unauthorized' }) | |
| async findAll(('status') status?: Status): Promise<CampusDto[]> { | |
| return this.campusService.findAll(status) as Promise<CampusDto[]>; | |
| } | |
| () | |
| (RoleName.IT_ADMIN, RoleName.ADMIN) | |
| (201) | |
| ({ | |
| summary: 'Create new campus', | |
| description: ` | |
| ## Create New Campus | |
| Creates a new campus in the system. | |
| ### Access Control | |
| - **Authentication Required**: ✅ Yes (Bearer Token) | |
| - **Roles Required**: ADMIN, IT_ADMIN only | |
| ### Notes | |
| - Campus names must be unique | |
| - New campuses are active by default | |
| `, | |
| }) | |
| ({ type: CreateCampusDto }) | |
| ({ status: 201, description: 'Campus created successfully' }) | |
| ({ status: 400, description: 'Invalid input data' }) | |
| ({ status: 401, description: 'Unauthorized' }) | |
| ({ status: 403, description: 'Forbidden - Admin access required' }) | |
| ({ status: 409, description: 'Campus name already exists' }) | |
| async create(() dto: CreateCampusDto): Promise<CampusDto> { | |
| return this.campusService.create(dto) as Promise<CampusDto>; | |
| } | |
| (':id') | |
| ( | |
| RoleName.IT_ADMIN, | |
| RoleName.ADMIN, | |
| RoleName.INSTRUCTOR, | |
| RoleName.TA, | |
| RoleName.STUDENT, | |
| ) | |
| ({ | |
| summary: 'Get campus by ID', | |
| description: ` | |
| ## Get Campus Details | |
| Retrieves details of a specific campus. | |
| ### Access Control | |
| - **Authentication Required**: ✅ Yes (Bearer Token) | |
| - **Roles Required**: All roles (STUDENT, INSTRUCTOR, TA, ADMIN, IT_ADMIN) | |
| `, | |
| }) | |
| ({ name: 'id', description: 'Campus ID', type: Number }) | |
| ({ status: 200, description: 'Campus details' }) | |
| ({ status: 401, description: 'Unauthorized' }) | |
| ({ status: 404, description: 'Campus not found' }) | |
| async findById(('id', ParseIntPipe) id: number): Promise<CampusDto> { | |
| return this.campusService.findById(id) as Promise<CampusDto>; | |
| } | |
| (':id') | |
| (RoleName.IT_ADMIN, RoleName.ADMIN) | |
| ({ | |
| summary: 'Update campus', | |
| description: ` | |
| ## Update Campus | |
| Updates an existing campus. | |
| ### Access Control | |
| - **Authentication Required**: ✅ Yes (Bearer Token) | |
| - **Roles Required**: ADMIN, IT_ADMIN only | |
| `, | |
| }) | |
| ({ name: 'id', description: 'Campus ID', type: Number }) | |
| ({ type: UpdateCampusDto }) | |
| ({ status: 200, description: 'Campus updated successfully' }) | |
| ({ status: 400, description: 'Invalid input data' }) | |
| ({ status: 401, description: 'Unauthorized' }) | |
| ({ status: 403, description: 'Forbidden - Admin access required' }) | |
| ({ status: 404, description: 'Campus not found' }) | |
| async update( | |
| ('id', ParseIntPipe) id: number, | |
| () dto: UpdateCampusDto, | |
| ): Promise<CampusDto> { | |
| return this.campusService.update(id, dto) as Promise<CampusDto>; | |
| } | |
| (':id') | |
| (RoleName.IT_ADMIN, RoleName.ADMIN) | |
| (204) | |
| ({ | |
| summary: 'Delete campus', | |
| description: ` | |
| ## Delete Campus | |
| Deletes a campus from the system. | |
| ### Access Control | |
| - **Authentication Required**: ✅ Yes (Bearer Token) | |
| - **Roles Required**: ADMIN, IT_ADMIN only | |
| ### ⚠️ Warning | |
| - Campuses with departments cannot be deleted | |
| - Consider deactivating instead of deleting | |
| `, | |
| }) | |
| ({ name: 'id', description: 'Campus ID', type: Number }) | |
| ({ status: 204, description: 'Campus deleted successfully' }) | |
| ({ status: 400, description: 'Cannot delete campus with departments' }) | |
| ({ status: 401, description: 'Unauthorized' }) | |
| ({ status: 403, description: 'Forbidden - Admin access required' }) | |
| ({ status: 404, description: 'Campus not found' }) | |
| async delete(('id', ParseIntPipe) id: number): Promise<void> { | |
| return this.campusService.delete(id); | |
| } | |
| } | |