[hongwei1]

Summary

Fixes issues where authentication documentation rendered on Portal / API Explorer and OpenAPI 3.1 auth schemas contained hardcoded URLs, invalid example endpoints, or placeholders:

1. Consumer Registration URL & Guide:

   • In OpenAPI31JSONFactory, consumerRegistrationUrl now points to /consumers/register when Portal URL is available, falling back to ${hostname}/consumer-registration.
   • Added consumerCreationGuideUrl (/developers/consumer-creation) and consumerRegistrationInstruction, clarifying Step 1 to guide developers to read the registration instructions, log in, and proceed to /consumers/register to register their application.
   • In APIUtil.getServerUrl, fall back to public_obp_api_url or hostname before raising an exception when documented_server_url is not set.

2. OIDC Token Endpoint & Discovery Resolution:

   • oAuth2Description previously hardcoded POST <OIDC_provider_token_endpoint>.
   • Added dynamic resolution for oidcTokenEndpoint from oauth2.obp_oidc.host or public_obp_oidc_url (/obp-oidc/token), falling back to <OIDC_provider_token_endpoint> if unconfigured.
   • Added oidcDiscoveryUrl to guide developers to the instance's OIDC discovery document and the GET /obp/v5.1.0/well-known endpoint.

3. Sample Endpoint Correction:

   • Updated the example requests in directLoginDescription, oAuth2Description, and gatewayLoginDescription from GET /obp/v6.0.0/my/banks (which returns 404) to the valid GET /obp/v7.0.0/my/banks endpoint.

4. Tests & CI:

   • Updated OpenAPI31FactoryTest to extend ServerSetup with FeatureSpec scenarios, covering fallback and dynamic resolution for consumer registration, guide instructions, OIDC token endpoint, discovery document, sample endpoints, and auth descriptions while adhering to test isolation requirements.

[sonarqubecloud]

Quality Gate passed

Issues
5 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud