Feat/81/create a department

[Kimoo193]

PR Checklist (required)

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines.

• Tests for the changes have been added (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Documentation changes
• Other... Please describe:

Related Issue

Closes #81

[Copilot]

Copilot reviewed 5 out of 6 changed files in this pull request and generated 1 comment.

Files not reviewed (1)

• src/docs/swagger.json: Language not supported

Comments suppressed due to low confidence (2)

src/routes/department.routes.js:10

• The route path '/api/department/all' does not match the documented endpoint '/api/departments' in the department controller. Consider updating the route for consistency.

  '/api/department/all',

src/controllers/user.controller.js:441

• The function 'deleteFromCloudinary' is used without being imported. Ensure that it is imported correctly to avoid runtime errors.

    await deleteFromCloudinary(user.profilePic);

[Kimoo193]

This pull request introduces a new endpoint to retrieve all departments, along with the necessary middleware, routes, and documentation updates. The most important changes include adding the getAllDepartments controller, updating the Swagger documentation, and incorporating new middleware for permission verification.

New Controller and Route:

• src/controllers/department.controller.js: Added the getAllDepartments controller to fetch and paginate department data.
• src/routes/department.routes.js: Created a new route for the getAllDepartments endpoint, including middleware for token verification and permission checks.

Middleware:

• src/middlewares/verifyManagerPermission.middleware.js: Added middleware to verify if the user has the role of MANAGER, ADMIN, or OWNER.

Swagger Documentation:

• src/docs/swagger.json: Updated Swagger documentation to include the new getAllDepartments endpoint and response schema. [1] [2] [3]

Application Setup:

• src/index.js: Imported the new department routes and updated CORS policy to allow specific origins and methods. [1] [2] [3]

[Copilot]

Copilot reviewed 4 out of 5 changed files in this pull request and generated 1 comment.

Files not reviewed (1)

• src/docs/swagger.json: Language not supported

Comments suppressed due to low confidence (1)

src/controllers/department.controller.js:5

• The documented route '/api/departments' does not match the implemented endpoint in the route file. Please update the documentation to reflect the correct endpoint.

 * @route  GET /api/departments