Skip to content

feat: add UK Open Banking Read/Write v4.0.1 support#2862

Merged
simonredfern merged 8 commits into
OpenBankProject:developfrom
hongwei1:develop-obp
Jul 13, 2026
Merged

feat: add UK Open Banking Read/Write v4.0.1 support#2862
simonredfern merged 8 commits into
OpenBankProject:developfrom
hongwei1:develop-obp

Conversation

@hongwei1

Copy link
Copy Markdown
Contributor

Summary

  • Add UK Open Banking Read/Write v4.0.1 support (spec-faithful scaffold): account info, payment initiation, confirmation of funds, event notifications, events, and VRP endpoints, with full test coverage.
  • Assorted CI/build maintenance riding along: Trivy filesystem vulnerability scanning, JDK 25 version fix in scan_dependencies workflow, and a thin-jar entrypoint path fix (MAVEN_OPTS to JAVA_OPTS rename).

Test plan

  • CI: all 9 shards green on this branch, including 6 UK v4.0.1 test suites (463 tests, 0 failures)
  • Already running in production (K8s), commit f1f3a54 confirmed live via /root endpoint

hongwei1 added 8 commits July 13, 2026 09:40
Adds code.api.UKOpenBanking.v4_0_1, mirroring the existing v3_1_0 http4s
implementation: a ScannedApis marker (OBP_UKOpenBanking_401), an aggregator,
and one endpoint object per sub-API (account-info, payment-initiation,
confirmation-funds, event-notifications, events, vrp). 89 endpoints total,
generated from the official read-write-api-specs v4.0.1 OpenAPI files. Since
those specs carry no response examples (only $ref'd schemas), each endpoint
returns an example synthesized from its schema rather than real connector
data; every endpoint requires authentication via ResourceDocMiddleware.

Wiring: new ScannedApiVersion in ApiVersion.scala, route mount in
Http4sApp.baseServices, resource-doc aggregation in APIUtil, and the UK
proprietary license clause in SwaggerJSONFactory.

Adds a matching test suite (code.api.UKOpenBanking.v4_0_1, 178 scenarios
across 6 classes) following the v3_1_0 pattern: unauthenticated requests
assert 401, authenticated requests assert the deterministic success code for
each endpoint's http4s helper (GET 200 / POST,PUT,PATCH 201 / DELETE 204).
Auto-covered by CI shard 6 (code.api.UKOpenBanking package prefix) with no
matrix changes needed.

Bumps ApiVersionUtilsTest's hardcoded scanned-version count (20 -> 21) per
its own documented convention for adding a new version.
@sonarqubecloud

Copy link
Copy Markdown

Quality Gate Failed Quality Gate failed

Failed conditions
C Security Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

💡 Need a hand with PR review? Try Gitar by Sonar!

@simonredfern simonredfern merged commit 5ea0645 into OpenBankProject:develop Jul 13, 2026
12 of 13 checks passed
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