Skip to content

Remove RFCs and the embedded swagger UI from docs - #4191

Merged
masih merged 4 commits into
mainfrom
masih/1789485349-remove-rfc-docs
Sep 16, 2026
Merged

masih merged 4 commits into
mainfrom
masih/1789485349-remove-rfc-docs

Conversation

@masih

@masih masih commented Sep 15, 2026

Copy link
Copy Markdown
Collaborator

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.swagger gated route registration and RegisterSwaggerAPI go away with it, along with the test that only checked that route; the api.swagger config key itself stays since it belongs to sei-cosmos.

@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@github-actions

github-actions Bot commented Sep 15, 2026

Copy link
Copy Markdown

The latest Buf updates on your PR. Results from workflow Buf / buf (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed✅ passed✅ passed✅ passedSep 15, 2026, 3:38 PM

@devin-ai-integration devin-ai-integration Bot changed the title Remove RFCs, embedded swagger UI and stale migration guides from docs Remove RFCs and the embedded swagger UI from docs Sep 15, 2026
@masih
masih marked this pull request as ready for review September 15, 2026 15:29
@codecov

codecov Bot commented Sep 15, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.56%. Comparing base (c45517d) to head (1aeb580).

Additional details and impacted files

Impacted file tree graph

@@            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              
Flag Coverage Δ
sei-chain-pr 55.32% <ø> (?)
sei-db 74.50% <ø> (ø)
sei-db-state-db ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
app/app.go 77.10% <ø> (-0.05%) ⬇️

... and 121 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@masih
masih requested a review from alexander-sei September 15, 2026 15:30
@cursor

cursor Bot commented Sep 15, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation and optional API-browser removal only; REST/gRPC query behavior is unchanged aside from losing /swagger/.

Overview
Removes stale docs and the in-node Swagger UI that were no longer maintained (old RFCs, ignite-driven OpenAPI embed, and related generator/config).

The API server no longer registers /swagger/: RegisterSwaggerAPI, the docs/swagger statik import, and the api.swagger-gated registration in RegisterAPIRoutes are deleted. api.swagger in app.toml remains as a sei-cosmos compatibility no-op. Tests that only asserted the swagger route are removed.

Also drops docs/rfc, docs/swagger-ui, the docs README describing the swagger flow, and the root config.yml ignite/openapi wiring.

Reviewed by Cursor Bugbot for commit 1aeb580. Bugbot is set up for automated code reviews on this repo. Configure here.

@seidroid seidroid Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.swagger defaults to true (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.swagger becomes 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 generated app.toml, and after this PR nothing in seid reads config.APIConfig.Swagger. Per REVIEW_GUIDELINES.md §5, that is the case where a key needs an explicit policy: state what an operator setting swagger = true should 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.

@masih
masih added this pull request to the merge queue Sep 16, 2026
Merged via the queue into main with commit d667212 Sep 16, 2026
72 checks passed
@masih
masih deleted the masih/1789485349-remove-rfc-docs branch September 16, 2026 07:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants