Strengthen OpenAPI contract coverage for implemented backend routes - #1041
Merged
Conversation
|
@BigMick03 is attempting to deploy a commit to the Ayomide Adeniran's projects Team on Vercel. A member of the Team first needs to authorize it. |
…auth, learning, certificates, health, and metrics - Add comprehensive @openapi JSDoc to 30+ endpoints across 5 route groups - Define shared component schemas (User, Certificate, CurriculumCourse, Progress, Error) - Fix repository URL and add contact email, license, externalDocs, tags - Add security: [] overrides for all public endpoints to prevent false auth requirements - Rewrite swagger tests: 181 assertions validating paths, schemas, tags, security, and $ref resolution - Remove stale controller globs from swagger-jsdoc apis array
|
@BigMick03 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Contributor
|
pr under review |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #885
Overview
This PR enhances the API documentation by improving OpenAPI coverage and making the generated specification a reliable integration contract. It also strengthens Swagger tests to catch documentation regressions.
Changes
Added documentation for representative Auth, Learning, Certificate, and Health endpoints.
Documented request bodies, success responses, error responses, authentication, and tags.
Updated stale repository and support metadata in the OpenAPI specification.
Improved Swagger/Jest tests to verify required paths, schemas, and security definitions.
Ensured the generated documentation matches the actual Express route behavior.
Benefits
Better API documentation for developers and integrators.
Prevents documentation from falling out of sync with the implementation.
Stronger automated tests to detect missing or broken API documentation.
Updated project metadata for accurate API information.
Testing
✅ OpenAPI specification generates successfully.
✅ Swagger UI renders without unresolved references.
✅ Jest tests validate required endpoints, schemas, and security definitions.
✅ Documented request and response models match implemented handlers.