Remove RFCs and the embedded swagger UI from docs - #4191
Conversation
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
The latest Buf updates on your PR. Results from workflow Buf / buf (pull_request).
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4191 +/- ##
==========================================
- Coverage 66.70% 65.56% -1.14%
==========================================
Files 2204 2083 -121
Lines 169825 157869 -11956
==========================================
- Hits 113279 103505 -9774
+ Misses 56405 54223 -2182
Partials 141 141
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
PR SummaryLow Risk Overview The API server no longer registers Also drops Reviewed by Cursor Bugbot for commit 1aeb580. Bugbot is set up for automated code reviews on this repo. Configure here. |
There was a problem hiding this comment.
A clean deletion-only PR removing the unmaintained RFCs and the embedded swagger UI; the Go-side removal is exact (no dangling references to docs/swagger/statik in the root module, rakyll/statik still legitimately required by sei-wasmd/sei-cosmos, and the pruned test imports match exactly what became unused). Two non-blocking notes concern the client-visible side: no CHANGELOG entry for dropping the default-on /swagger/ endpoint, and the now-inert api.swagger key that generated app.toml still documents as functional.
Findings: 0 blocking | 2 non-blocking | 0 posted inline
Blockers
- None at the file/PR level.
Non-blocking
- [suggestion] No CHANGELOG entry for a client-visible removal.
api.swaggerdefaults totrue(sei-cosmos/server/config/config.go:447), so/swagger/was served on any node with the API server enabled and now returns 404. The repo records comparable removals under## Unreleased(e.g. #4117 removing the evmone path, #3881 removing the interchain swagger API); an Improvements or Client Breaking line here would keep that record complete. - [suggestion]
api.swaggerbecomes an inert config key while still being documented as functional. sei-cosmos/server/config/toml.go:178 writes "Swagger defines if swagger documentation should automatically be registered" into every generatedapp.toml, and after this PR nothing in seid readsconfig.APIConfig.Swagger. Per REVIEW_GUIDELINES.md §5, that is the case where a key needs an explicit policy: state what an operator settingswagger = trueshould now expect (no-op, retained for sei-cosmos compatibility) in the PR/CHANGELOG, rather than leaving the promise in the node's own config file unanswered.
The docs folder had accumulated content nobody maintains: the two RFCs and RFC template last touched years ago, the embedded swagger UI whose 45k-line statik.go is regenerated by an ignite v0.23.0 script nobody runs.
This removes docs/rfc, docs/swagger and docs/swagger-ui along with the generator script, the ignite config.yml and the docs README that only described the swagger flow. In app.go the statik blank import, the
api.swaggergated route registration andRegisterSwaggerAPIgo away with it, along with the test that only checked that route; theapi.swaggerconfig key itself stays since it belongs to sei-cosmos.