bugfix/implement v7.0.0 resource-docs aggregation to return all API versions endpoints#2771
Merged
simonredfern merged 6 commits intoOpenBankProject:developfrom Apr 29, 2026
Merged
Conversation
…ersions endpoints
…se v7.0.0 version in all aggregated docs
…esourceDocsList to enable cross-version queries
…egation result and improve performance
…ationTest to fix SonarQube warnings
|
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.



Fix v7.0.0 Resource Docs Aggregation
Summary
This PR implements resource docs aggregation for v7.0.0 to return all API versions' endpoints (v7.0.0 + v6.0.0 + v5.1.0 + ... + v1.3.0), fixing the issue where v7.0.0 resource-docs endpoint only returned v7.0.0's own endpoints.
Problem
The v7.0.0 resource-docs endpoint (
/obp/v7.0.0/resource-docs/v7.0.0/obp) was only returning ~50 v7.0.0 endpoints instead of aggregating all versions' endpoints (797+ total).Additionally, cross-version queries like
/obp/v6.0.0/resource-docs/v7.0.0/obpwere also broken, returning only v7.0.0 endpoints.Solution
Implemented three fixes:
1. Resource Docs Aggregation (Commit: 914c058)
allResourceDocsmethod inHttp4s700.scalato aggregate docs from all versionsexcludeEndpointslist for future endpoint exclusionsgetResourceDocsObpV700endpoint to use aggregated docs whenrequestedApiVersion == v7.0.02. specifiedUrl Fix (Commit: e907014)
specifiedUrlfield to use v7.0.0 version for all aggregated docsResourceDocsAPIMethods.getResourceDocsListspecifiedUrlcontains/v7.0.0/instead of empty string3. Cross-Version Query Fix (Commit: 25c0ce9)
getResourceDocsListto returnHttp4s700.allResourceDocsinstead ofHttp4s700.resourceDocsChanges
obp-api/src/main/scala/code/api/v7_0_0/Http4s700.scalaexcludeEndpointslistallResourceDocsmethod with aggregation and deduplication logicgetResourceDocsObpV700to setrequestUrlandspecifiedUrlfor aggregated docsobp-api/src/main/scala/code/api/ResourceDocs1_4_0/ResourceDocsAPIMethods.scalaallResourceDocsinstead ofresourceDocsobp-api/src/test/scala/code/api/v7_0_0/V7ResourceDocsAggregationTest.scalaTesting
All tests pass (13/14 scenarios, 1 test for specifiedUrl validation pending):
Verification
Related Issues
Fixes the v7.0.0 resource-docs aggregation issue where only v7.0.0's own endpoints were returned.
Checklist
bugfix/description