This PR updates the documentation for the Two-Factor Authentication (2FA) endpoints in the swagger.yaml file. The updates include detailed descriptions of the /auth/2fa/enable and /auth/2fa/verify endpoints, including request bodies, success responses, and error responses. The changes are aimed at providing better guidance for frontend and backend developers who will implement or integrate these endpoints.
Related Issue
How Has This Been Tested?
The changes have been manually verified by reviewing the rendered Swagger documentation. The endpoints and their corresponding request/response formats have been checked against the updated swagger.yaml file to ensure accuracy and completeness.
Screenshots
If applicable, include screenshots showing the updated Swagger UI with the 2FA documentation. (For example, screenshots from Postman or Swagger UI showing the request and response examples.)
Types of changes
[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
Checklist
[x] My code follows the code style of this project.
Description
This PR updates the documentation for the Two-Factor Authentication (2FA) endpoints in the
swagger.yamlfile. The updates include detailed descriptions of the/auth/2fa/enableand/auth/2fa/verifyendpoints, including request bodies, success responses, and error responses. The changes are aimed at providing better guidance for frontend and backend developers who will implement or integrate these endpoints.Related Issue
How Has This Been Tested?
The changes have been manually verified by reviewing the rendered Swagger documentation. The endpoints and their corresponding request/response formats have been checked against the updated
swagger.yamlfile to ensure accuracy and completeness.Screenshots
If applicable, include screenshots showing the updated Swagger UI with the 2FA documentation. (For example, screenshots from Postman or Swagger UI showing the request and response examples.)
Types of changes
Checklist