Skip to content

E2e tested openapi spec with swagger endpoint #1523

Merged
pragmaxim merged 9 commits into
masterfrom
e2e-tested-openapi-spec
May 27, 2026
Merged

E2e tested openapi spec with swagger endpoint #1523
pragmaxim merged 9 commits into
masterfrom
e2e-tested-openapi-spec

Conversation

@pragmaxim

@pragmaxim pragmaxim commented May 25, 2026

Copy link
Copy Markdown
Contributor

What this PR adds and fixes, see api.md :

  1. openapi.yaml and swagger-ui
  2. e2e in typescript, not in golang anymore, simpler, leaner, openapi native, clients like trezor-suite use it including blockbook-api.ts that should be compatible with openapi.yaml, TS compiler can check it
  3. e2e were wrongly mixed together with integration tests, it got separated
  4. CI/CD verifies blockbook-api.ts is up to date and validated against openapi.yaml by TS compiler !!!
  • Drawback - package-lock.json for the dependencies around Openapi and Swagger is ~ 4000 LOC
  • This is a way how to make PRs with API changes without some obscure communication issues

Unfortunately there is no way to generate openapi.yaml since blockbook api does not use any modern frameworks, however we keep it unified with blockbook-api.ts generated from the golang types ... that will provide enough for trezor-suite to integrate againts.

@pragmaxim pragmaxim requested review from cranycrane and removed request for cranycrane May 25, 2026 11:59
@pragmaxim pragmaxim marked this pull request as draft May 26, 2026 05:30
@pragmaxim pragmaxim force-pushed the e2e-tested-openapi-spec branch from 39dad41 to 8f2729f Compare May 26, 2026 05:59
@pragmaxim pragmaxim force-pushed the e2e-tested-openapi-spec branch from 8f2729f to 8b1baab Compare May 26, 2026 06:43
@pragmaxim pragmaxim marked this pull request as ready for review May 26, 2026 09:19
@pragmaxim pragmaxim requested a review from cranycrane May 26, 2026 09:19
@pragmaxim pragmaxim merged commit 081e538 into master May 27, 2026
3 checks passed
@pragmaxim pragmaxim deleted the e2e-tested-openapi-spec branch May 27, 2026 08:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants