Skip to content

Created toolkit-template code with openapi.yaml #852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
iamSahdoon wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Created toolkit-template code with openapi.yaml #852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ae73869
Created toolkit-template code with openapi.yaml
iamSahdoon Oct 30, 2025
c4b7920
Changed the toolkit template folder structure
iamSahdoon Nov 4, 2025
ac660cb
Changed package names of generated models and apis (after changing fo…
iamSahdoon Nov 7, 2025
eb8e053
Added 4 functions that are common for the other toolkits
iamSahdoon Nov 7, 2025
6e1df27
Removed an unnecessary dependency added during common functions integ…
iamSahdoon Nov 7, 2025
ef9976d
Removed and added some dependencies and plugins in pom.xml, made chan…
iamSahdoon Nov 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
~ specific language governing permissions and limitations
~ under the License.
-->

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>

Expand Down Expand Up @@ -43,6 +44,7 @@
<modules>
<module>financial-services-accelerator</module>
<module>financial-services-accelerator/accelerators</module>
<module>toolkit-template</module>
</modules>
<build>
<plugins>
Expand Down Expand Up @@ -189,6 +191,7 @@
<consoleOutput>true</consoleOutput>
<failsOnError>true</failsOnError>
<includeTestSourceDirectory>true</includeTestSourceDirectory>
<excludes>**/generated/**/**</excludes>
</configuration>
<goals>
<goal>check</goal>
Expand Down Expand Up @@ -233,6 +236,7 @@
<configuration>
<obrRepository>NONE</obrRepository>
<instructions>
<!--suppress UnresolvedMavenProperty -->
<SCM-Revision>${buildNumber}</SCM-Revision>
</instructions>
</configuration>
Expand Down Expand Up @@ -272,6 +276,49 @@
</build>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>jakarta.ws.rs</groupId>
<artifactId>jakarta.ws.rs-api</artifactId>
<version>${jakarta.ws.rs-version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
<version>${jackson-version}</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.jaxrs</groupId>
<artifactId>jackson-jaxrs-json-provider</artifactId>
<version>${jackson-version}</version>
</dependency>
<dependency>
<groupId>joda-time</groupId>
<artifactId>joda-time</artifactId>
<version>${joda-version}</version>
</dependency>
<dependency>
<groupId>javax.annotation</groupId>
<artifactId>javax.annotation-api</artifactId>
<version>${javax.annotation-api-version}</version>
</dependency>
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<scope>provided</scope>
<version>${swagger-annotations.version}</version>
</dependency>
<dependency>
<groupId>org.json</groupId>
<artifactId>json</artifactId>
<version>${json.version}</version>
</dependency>
Comment on lines +311 to +315
Copy link

@coderabbitai coderabbitai bot Nov 13, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

Upgrade org.json version to address HIGH-severity vulnerabilities.

The json.version property is set to 20210307 (line 728), which has known HIGH-severity vulnerabilities (GHSA-3vqj-43w4-2q58: stack overflow, GHSA-4jq9-2xhw-jpx7: DoS). This outdated version from 2021 is consumed by the new toolkit-template module.

Upgrade to the latest stable version to address these vulnerabilities:

-        <json.version>20210307</json.version>
+        <json.version>20240303</json.version>

Verify compatibility after upgrading and run tests to ensure no breaking changes.

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents 
In pom.xml around lines 311-315 (and update the json.version property at line
728), the project depends on org.json:json at an outdated 20210307 which has
HIGH-severity vulnerabilities; update the json.version property to the latest
stable release that includes the security fixes, ensure the dependency block
continues to reference ${json.version}, run a full build (mvn -U test or mvn
-DskipTests=false test) and the test suite to verify compatibility, and fix any
API changes caused by the upgraded library.

<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>${javax.servlet.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
Expand Down Expand Up @@ -675,5 +722,12 @@
<org.apache.commons.io.version.range>[2.15.1, 2.16.0)</org.apache.commons.io.version.range>
<org.json.version.range>[3.0.0, 4.0.0)</org.json.version.range>
<jjwt.version.range>[0.9.1, 0.9.2)</jjwt.version.range>
<jakarta.ws.rs-version>2.1.6</jakarta.ws.rs-version>
<joda-version>2.10.13</joda-version>
<javax.annotation-api-version>1.3.2</javax.annotation-api-version>
<json.version>20210307</json.version>
<jackson-version>2.17.1</jackson-version>
<swagger-annotations.version>1.6.14</swagger-annotations.version>
<javax.servlet.version>4.0.1</javax.servlet.version>
</properties>
</project>
23 changes: 23 additions & 0 deletions toolkit-template/.openapi-generator-ignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
141 changes: 141 additions & 0 deletions toolkit-template/.openapi-generator/FILES
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
.openapi-generator-ignore
README.md
pom.xml
src/gen/java/org/openapitools/api/EnrichConsentCreationResponseApi.java
src/gen/java/org/openapitools/api/EnrichConsentFileResponseApi.java
src/gen/java/org/openapitools/api/EnrichConsentSearchResponseApi.java
src/gen/java/org/openapitools/api/EnrichEventPollingResponseApi.java
src/gen/java/org/openapitools/api/EnrichEventSubscriptionResponseApi.java
src/gen/java/org/openapitools/api/IssueRefreshTokenApi.java
src/gen/java/org/openapitools/api/MapAcceleratorErrorResponseApi.java
src/gen/java/org/openapitools/api/PersistAuthorizedConsentApi.java
src/gen/java/org/openapitools/api/PopulateConsentAuthorizeScreenApi.java
src/gen/java/org/openapitools/api/PreProcessApplicationCreationApi.java
src/gen/java/org/openapitools/api/PreProcessApplicationUpdateApi.java
src/gen/java/org/openapitools/api/PreProcessClientCreationApi.java
src/gen/java/org/openapitools/api/PreProcessClientRetrievalApi.java
src/gen/java/org/openapitools/api/PreProcessClientUpdateApi.java
src/gen/java/org/openapitools/api/PreProcessConsentCreationApi.java
src/gen/java/org/openapitools/api/PreProcessConsentFileUploadApi.java
src/gen/java/org/openapitools/api/PreProcessConsentRetrievalApi.java
src/gen/java/org/openapitools/api/PreProcessConsentRevokeApi.java
src/gen/java/org/openapitools/api/RestApplication.java
src/gen/java/org/openapitools/api/RestResourceRoot.java
src/gen/java/org/openapitools/api/ValidateAuthorizationRequestApi.java
src/gen/java/org/openapitools/api/ValidateConsentAccessApi.java
src/gen/java/org/openapitools/api/ValidateConsentFileRetrievalApi.java
src/gen/java/org/openapitools/api/ValidateEventCreationApi.java
src/gen/java/org/openapitools/api/ValidateEventPollingApi.java
src/gen/java/org/openapitools/api/ValidateEventSubscriptionApi.java
src/gen/java/org/openapitools/model/Account.java
src/gen/java/org/openapitools/model/AmendedAuthorization.java
src/gen/java/org/openapitools/model/AmendedResource.java
src/gen/java/org/openapitools/model/AppCreateProcessData.java
src/gen/java/org/openapitools/model/AppCreateProcessRequestBody.java
src/gen/java/org/openapitools/model/AppUpdateProcessData.java
src/gen/java/org/openapitools/model/AppUpdateProcessRequestBody.java
src/gen/java/org/openapitools/model/Authorization.java
src/gen/java/org/openapitools/model/AuthorizedResources.java
src/gen/java/org/openapitools/model/AuthorizedResourcesAuthorizedDataInner.java
src/gen/java/org/openapitools/model/ClientProcessData.java
src/gen/java/org/openapitools/model/ClientProcessRequestBody.java
src/gen/java/org/openapitools/model/ConsentSearchData.java
src/gen/java/org/openapitools/model/DetailedConsentResourceData.java
src/gen/java/org/openapitools/model/DetailedConsentResourceDataWithAmendments.java
src/gen/java/org/openapitools/model/EnrichConsentCreationRequestBody.java
src/gen/java/org/openapitools/model/EnrichConsentSearchRequestBody.java
src/gen/java/org/openapitools/model/EnrichFileUploadResponseRequestBody.java
src/gen/java/org/openapitools/model/Error.java
src/gen/java/org/openapitools/model/ErrorMapperData.java
src/gen/java/org/openapitools/model/ErrorMapperRequestBody.java
src/gen/java/org/openapitools/model/ErrorResponse.java
src/gen/java/org/openapitools/model/EventCreationRequest.java
src/gen/java/org/openapitools/model/EventCreationRequestBody.java
src/gen/java/org/openapitools/model/EventPollingRequest.java
src/gen/java/org/openapitools/model/EventPollingRequestBody.java
src/gen/java/org/openapitools/model/EventSubscriptionRequest.java
src/gen/java/org/openapitools/model/EventSubscriptionRequestBody.java
src/gen/java/org/openapitools/model/FailedResponse.java
src/gen/java/org/openapitools/model/FailedResponseApplicationProcess.java
src/gen/java/org/openapitools/model/FailedResponseApplicationProcessData.java
src/gen/java/org/openapitools/model/FailedResponseClientProcess.java
src/gen/java/org/openapitools/model/FailedResponseClientProcessData.java
src/gen/java/org/openapitools/model/FailedResponseInConsentAuthorize.java
src/gen/java/org/openapitools/model/FailedResponseInConsentAuthorizeData.java
src/gen/java/org/openapitools/model/IssueRefreshTokenRequestBody.java
src/gen/java/org/openapitools/model/IssueRefreshTokenRequestData.java
src/gen/java/org/openapitools/model/PersistAuthorizedConsent.java
src/gen/java/org/openapitools/model/PersistAuthorizedConsentRequestBody.java
src/gen/java/org/openapitools/model/PopulateConsentAuthorizeScreenData.java
src/gen/java/org/openapitools/model/PopulateConsentAuthorizeScreenRequestBody.java
src/gen/java/org/openapitools/model/PreProcessConsentCreationRequestBody.java
src/gen/java/org/openapitools/model/PreProcessConsentRequestBody.java
src/gen/java/org/openapitools/model/PreProcessConsentRetrievalData.java
src/gen/java/org/openapitools/model/PreProcessFileUploadRequestBody.java
src/gen/java/org/openapitools/model/Request.java
src/gen/java/org/openapitools/model/RequestForEnrichConsentCreationResponse.java
src/gen/java/org/openapitools/model/RequestForEnrichFileUploadResponse.java
src/gen/java/org/openapitools/model/RequestForPreProcessFileUpload.java
src/gen/java/org/openapitools/model/Resource.java
src/gen/java/org/openapitools/model/Response200.java
src/gen/java/org/openapitools/model/Response200ForApplicationCreation.java
src/gen/java/org/openapitools/model/Response200ForApplicationUpdate.java
src/gen/java/org/openapitools/model/Response200ForClientProcess.java
src/gen/java/org/openapitools/model/Response200ForConsentRevocation.java
src/gen/java/org/openapitools/model/Response200ForConsentSearch.java
src/gen/java/org/openapitools/model/Response200ForEnrichEventPolling.java
src/gen/java/org/openapitools/model/Response200ForEnrichEventSubscription.java
src/gen/java/org/openapitools/model/Response200ForErrorMapper.java
src/gen/java/org/openapitools/model/Response200ForEventSubscriptionValidation.java
src/gen/java/org/openapitools/model/Response200ForEventValidation.java
src/gen/java/org/openapitools/model/Response200ForIssueRefreshToken.java
src/gen/java/org/openapitools/model/Response200ForPersistAuthorizedConsent.java
src/gen/java/org/openapitools/model/Response200ForPopulateConsentAuthorizeScreen.java
src/gen/java/org/openapitools/model/Response200ForPreProcessConsentCreation.java
src/gen/java/org/openapitools/model/Response200ForPreProcessFileUpload.java
src/gen/java/org/openapitools/model/Response200ForResponseAlternation.java
src/gen/java/org/openapitools/model/Response200ForValidateAuthorizationRequest.java
src/gen/java/org/openapitools/model/StoredAuthorization.java
src/gen/java/org/openapitools/model/StoredBasicConsentResourceData.java
src/gen/java/org/openapitools/model/StoredDetailedConsentResourceData.java
src/gen/java/org/openapitools/model/StoredResource.java
src/gen/java/org/openapitools/model/SuccessResponse.java
src/gen/java/org/openapitools/model/SuccessResponseApplicationCreation.java
src/gen/java/org/openapitools/model/SuccessResponseApplicationCreationData.java
src/gen/java/org/openapitools/model/SuccessResponseApplicationUpdate.java
src/gen/java/org/openapitools/model/SuccessResponseApplicationUpdateData.java
src/gen/java/org/openapitools/model/SuccessResponseClientProcess.java
src/gen/java/org/openapitools/model/SuccessResponseClientProcessData.java
src/gen/java/org/openapitools/model/SuccessResponseConsentRevocation.java
src/gen/java/org/openapitools/model/SuccessResponseConsentRevocationData.java
src/gen/java/org/openapitools/model/SuccessResponseForConsentSearch.java
src/gen/java/org/openapitools/model/SuccessResponseForConsentSearchData.java
src/gen/java/org/openapitools/model/SuccessResponseForEnrichEventPolling.java
src/gen/java/org/openapitools/model/SuccessResponseForEnrichEventPollingData.java
src/gen/java/org/openapitools/model/SuccessResponseForEnrichEventSubscription.java
src/gen/java/org/openapitools/model/SuccessResponseForEnrichEventSubscriptionData.java
src/gen/java/org/openapitools/model/SuccessResponseForEventWithDetails.java
src/gen/java/org/openapitools/model/SuccessResponseForEventWithDetailsData.java
src/gen/java/org/openapitools/model/SuccessResponseForResponseAlternation.java
src/gen/java/org/openapitools/model/SuccessResponseForResponseAlternationData.java
src/gen/java/org/openapitools/model/SuccessResponseIssueRefreshToken.java
src/gen/java/org/openapitools/model/SuccessResponseIssueRefreshTokenData.java
src/gen/java/org/openapitools/model/SuccessResponsePersistAuthorizedConsent.java
src/gen/java/org/openapitools/model/SuccessResponsePersistAuthorizedConsentData.java
src/gen/java/org/openapitools/model/SuccessResponsePopulateConsentAuthorizeScreen.java
src/gen/java/org/openapitools/model/SuccessResponsePopulateConsentAuthorizeScreenData.java
src/gen/java/org/openapitools/model/SuccessResponsePopulateConsentAuthorizeScreenDataConsentData.java
src/gen/java/org/openapitools/model/SuccessResponsePopulateConsentAuthorizeScreenDataConsentDataPermissionsInner.java
src/gen/java/org/openapitools/model/SuccessResponsePopulateConsentAuthorizeScreenDataConsumerData.java
src/gen/java/org/openapitools/model/SuccessResponsePopulateConsentAuthorizeScreenDataConsumerDataAccountsInner.java
src/gen/java/org/openapitools/model/SuccessResponsePreProcessConsentCreation.java
src/gen/java/org/openapitools/model/SuccessResponsePreProcessFileUpload.java
src/gen/java/org/openapitools/model/SuccessResponsePreProcessFileUploadData.java
src/gen/java/org/openapitools/model/SuccessResponseWithDetailedConsentData.java
src/gen/java/org/openapitools/model/SuccessResponseWithDetailedConsentDataAndAmendments.java
src/gen/java/org/openapitools/model/UserGrantedData.java
src/gen/java/org/openapitools/model/ValidateAuthorizationRequestBody.java
src/gen/java/org/openapitools/model/ValidateAuthorizationRequestBodyData.java
src/gen/java/org/openapitools/model/ValidateConsentAccessData.java
src/gen/java/org/openapitools/model/ValidateConsentAccessRequestBody.java
src/main/openapi/openapi.yaml
1 change: 1 addition & 0 deletions toolkit-template/.openapi-generator/VERSION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
7.16.0
63 changes: 63 additions & 0 deletions toolkit-template/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<!--
~ Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
~
~ WSO2 LLC. licenses this file to you under the Apache License,
~ Version 2.0 (the "License"); you may not use this file except
~ in compliance with the License.
~ You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing,
~ software distributed under the License is distributed on an
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~ KIND, either express or implied. See the License for the
~ specific language governing permissions and limitations
~ under the License.
-->

# WSO2 Toolkit Template

The WSO2 Open Banking Toolkit Template acts as the foundational framework for regional Open Banking Toolkit implementations. It standardizes common components, configurations, and functions, enabling regional teams to focus on region-specific compliance requirements without rebuilding core functionality from scratch.

### Building from the source

If you want to build the WSO2 Toolkit Template from the source code:

1. Install Java8 or above.
Copy link

@coderabbitai coderabbitai bot Nov 13, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix spacing in Java version reference.

"Java8" should be "Java 8" for proper formatting.

Apply this diff:

-1. Install Java8 or above.
+1. Install Java 8 or above.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
1. Install Java8 or above.
1. Install Java 8 or above.
🧰 Tools
🪛 LanguageTool

[grammar] ~27-~27: Ensure spelling is correct
Context: ...plate from the source code: 1. Install Java8 or above. 2. Install [Apache Maven 3.0....

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents 
In toolkit-template/README.md around line 27, the Java version reference "Java8"
is missing a space; update the text to "Java 8" so the line reads "Install Java
8 or above." to correct formatting and consistency.

2. Install [Apache Maven 3.0.5](https://maven.apache.org/download.cgi) or above.
3. Get the Financial Services Accelerator from [this repository](https://github.com/wso2/financial-services-accelerator.git) by **cloning** or **downloading** the repository as a zip.
* To **clone the solution**, copy the URL and execute the following command in a command prompt.
`git clone <the copiedURL>`. After cloning, checkout to the **main** branch.
* To **download the repository**, select the **main** branch first, then click **Download ZIP** and unzip the downloaded file.
4. Navigate to the cloned/downloaded repository using a command prompt and run the relevant Maven command:

| Command | Description |
|:------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ```mvn install``` | This starts building the repository without cleaning the folders. |
| ```mvn clean install``` | This cleans the folders and starts building the repository from scratch. |
| ```mvn clean install -P solution``` | This cleans the folders and starts building the repository and the accelerator packs from scratch, finally it creates the accelerator zip files containing the artifacts required to setup the deployment. |

5. Once the packs are created, navigate to the relevant folder to get the accelerator for each product:

| Product | Toolkit Path |
|:----------------------------------------|:----------------------------------------------------------------|
| ```Identity Server Accelerator``` | `/financial-services-accelerator/accelerators/fs-is/target` |
| ```API Manager Accelerator``` | `/financial-services-accelerator/accelerators/fs-apim/target` |

### Installing and Running OB Accelerators

Please refer the following README files to run the products:

| Product | Instructions Path |
|:----------------------------------|:------------------------------------------|
| ```Identity Server Accelerator``` | `/wso2-fsiam-accelerator-4.0.0/README.md` |
| ```API Manager Accelerator``` | `/wso2-fsam-accelerator-4.0.0/README.md` |

### Reporting Issues

We encourage you to report issues, documentation faults, and feature requests regarding the Toolkit Template through the [WSO2 Financial Services Accelerator Issue Tracker](https://github.com/wso2/financial-services-accelerator/issues).

### License

This source is licensed under the Apache License Version 2.0 ([LICENSE](LICENSE)).
Loading