Repository navigation
Feature/auto generate swagger - #12
Merged
Merged
Conversation
ravilock
force-pushed
the
feature/auto-generate-swagger
branch
from
September 24, 2026 17:01
2b518c4 to
c3b39b6
Compare
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The declared Go minimum is incompatible with Echo v4.13.3, and the served API version remains a placeholder.
Get a fresh assessment by requesting another Copilot review.
Review effort: Balanced
Findings: 2
Open (2)
What changed in this PR
Adds generated Swagger 2.0 documentation and a public Swagger UI.
Changes:
- Adds Swag annotations and generated specifications.
- Serves Swagger UI and validates generated files in CI.
- Migrates Echo from v3 to v4.
| File | Description |
|---|---|
| README.md | Documents Swagger usage. |
| Makefile | Adds generation/check targets. |
| go.mod | Adds Swagger and Echo v4 dependencies. |
| go.sum | Updates dependency checksums. |
| docs/swagger.yaml | Generated YAML specification. |
| docs/swagger.json | Generated JSON specification. |
| docs/docs.go | Embeds the generated specification. |
| api/api.go | Registers Swagger and updates Echo setup. |
| api/api_test.go | Tests public Swagger access. |
| api/apps.go | Documents application endpoints. |
| api/docs_types.go | Adds documentation response types. |
| api/jobs.go | Documents job endpoints. |
| api/observability.go | Migrates Echo import. |
| api/rule.go | Documents rule endpoints. |
| api/service.go | Documents service endpoints. |
| api/service_test.go | Migrates Echo test import. |
| .github/workflows/ci.yaml | Checks generated documentation. |
Files not reviewed (1)
- docs/docs.go: Generated file
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| github.com/evanphx/json-patch/v5 v5.6.0 | ||
| github.com/google/gops v0.3.3-0.20171222022621-e09130d89827 | ||
| github.com/labstack/echo v3.2.5+incompatible | ||
| github.com/labstack/echo/v4 v4.13.3 |
crgisch
approved these changes
Sep 28, 2026
| msg = he.Message | ||
| if he.Inner != nil { | ||
| msg = fmt.Sprintf("%v, %v", err, he.Inner) | ||
| if he.Internal != nil { |
Member
There was a problem hiding this comment.
Echo V4 supposedly includes internal already
Might be worth checking if its not being duplicated? (idt we have tests covering this atm)
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
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.
No description provided.