docs/swagger-documentations

[mdawoud27]

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 #45

[Copilot]

Pull Request Overview

This PR introduces comprehensive Swagger documentation for authentication endpoints along with integrating Swagger UI into the application. Key changes include:

• Adding Swagger JSDocs for authentication routes in src/routes/auth.routes.js.
• Integrating Swagger UI with Swagger JSDoc in src/index.js.
• Updating API documentation comments in src/controllers/auth.controller.js to reflect Swagger specifications.

Reviewed Changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated no comments.

File	Description
src/routes/auth.routes.js	Added Swagger documentation for each auth endpoint
src/index.js	Integrated Swagger UI and updated API documentation path
src/controllers/auth.controller.js	Replaced previous inline comments with Swagger documentation blocks

Files not reviewed (1)

• package.json: Language not supported

Comments suppressed due to low confidence (1)

src/routes/auth.routes.js:285

• [nitpick] The endpoint for Google OAuth is defined as '/auth/google' while the other endpoints are prefixed with '/api/auth'. Consider unifying the endpoint prefixes for consistency.

// Google OAuth Login/Signup Endpoint (for mobile/SPA)