OpenAPI 3.1 Spec Documentation #1538
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive OpenAPI 3.1 specification documentation to the devguard API. The PR includes Swagger/OpenAPI annotations throughout the codebase and generates a complete swagger.yaml specification file.
Changes:
- Added OpenAPI annotations to all controller endpoints (60+ endpoints documented)
- Enhanced data model annotations with proper swagger types for date fields
- Configured security definitions for CookieAuth and ApiKeyAuth
- Added Makefile target for regenerating documentation
Reviewed changes
Copilot reviewed 19 out of 21 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/swagger.yaml | Generated OpenAPI 2.0 specification with 4209 lines covering all API endpoints |
| router/session_router.go | Added @summary, @Security, and @success annotations for whoami endpoint |
| dtos/dependency_vuln_dto.go | Added swaggertype and format tags for CISA date fields |
| database/models/cve_model.go | Added swaggertype and format tags for CISA date fields in CVE model |
| controllers/*.go (15 files) | Added comprehensive OpenAPI annotations for all controller methods |
| cmd/devguard/main.go | Added security definitions for CookieAuth and ApiKeyAuth |
| Makefile | Added docs target to regenerate OpenAPI specification using swag |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| // @Summary Create webhook integration | ||
| // @Security CookieAuth | ||
| // @Security ApiKeyAuth | ||
| // @Param body body object true "Webhook data" | ||
| // @Success 200 {object} dtos.WebhookIntegrationDTO | ||
| // @Router /webhooks [post] |
There was a problem hiding this comment.
The OpenAPI annotation comment is placed after the closing brace of the previous function rather than immediately before the function it documents. This creates a disconnect between the documentation and the function, making the code harder to maintain. The comment block should be moved to appear directly before the Save function declaration.
No description provided.