DigiFi/digifi-BankEmulator
1
0
Fork 0
Code Issues Pull Requests Releases Activity

[add]: Swagger Documentation

Browse Source
This commit is contained in:
VivianDee
2025-03-24 08:44:57 +01:00
parent 7a4a9a9b99
commit dad8e68c9f
72 changed files with 1679 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/swagger/paths/CollectLoan.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"CollectLoan"
],
"summary": "Collect Loan Request",
"description": "Collect Loan Request",
"operationId": "CollectLoan",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/CollectLoanRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/CollectLoanRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/CollectLoanRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "CollectLoan Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/CollectLoanResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/CollectLoanResponse.json"
}
}
}
},
"400": {
"description": "Invalid request parameters"
},
"500": {
"description": "Internal server error"
}
}
}
}
app/swagger/paths/CustomerConsent.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"CustomerConsent"
],
"summary": "Customer Consent Request",
"description": "Customer Consent Request",
"operationId": "CustomerConsent",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/CustomerConsentRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/CustomerConsentRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/CustomerConsentRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/CustomerConsentResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/CustomerConsentResponse.json"
}
}
}
},
"400": {
"description": "Invalid request parameters"
},
"500": {
"description": "Internal server error"
}
}
}
}
app/swagger/paths/Disbursement.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"Disbursement"
],
"summary": "Disbursement Request",
"description": "Disbursement Request",
"operationId": "Disbursement",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/DisbursementRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/DisbursementRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/DisbursementRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "Disbursement Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/DisbursementResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/DisbursementResponse.json"
}
}
}
},
"400": {
"description": "Invalid request parameters"
},
"500": {
"description": "Internal server error"
}
}
}
}
app/swagger/paths/LienCheck.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"LienCheck"
],
"summary": "Lien Check Request",
"description": "Lien Check Request",
"operationId": "LienCheck",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/LienCheckRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/LienCheckRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/LienCheckRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "LienCheck Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/LienCheckResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/LienCheckResponse.json"
}
}
}
},
"400": {
"description": "Invalid request parameters"
},
"500": {
"description": "Internal server error"
}
}
}
}
app/swagger/paths/NewTransactionCheck.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"NewTransactionCheck"
],
"summary": "New Transaction Check Request",
"description": "New Transaction Check Request",
"operationId": "NewTransactionCheck",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/NewTransactionCheckRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/NewTransactionCheckRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/NewTransactionCheckRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "NewTransactionCheck Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/NewTransactionCheckResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/NewTransactionCheckResponse.json"
}
}
}
},
"400": {
"description": "Invalid request parameters"
},
"500": {
"description": "Internal server error"
}
}
}
}
app/swagger/paths/PenalCharge.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"PenalCharge"
],
"summary": "Penal Charge Request",
"description": "Penal Charge Request",
"operationId": "PenalCharge",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/PenalChargeRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/PenalChargeRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/PenalChargeRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "PenalCharge Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/PenalChargeResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/PenalChargeResponse.json"
}
}
}
},
"400": {
"description": "Invalid request parameters"
},
"500": {
"description": "Internal server error"
}
}
}
}
app/swagger/paths/RACCheck.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"RACCheck"
],
"summary": "Risk Acceptance Criteria Check",
"description": "Check if a customer passes the Risk Acceptance Criteria defined by the bank",
"operationId": "racCheck",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/RACCheckRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/RACCheckRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/RACCheckRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "RAC Check Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/RACCheckResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/RACCheckResponse.json"
}
}
}
},
"400": {
"description": "Invalid request parameters"
},
"500": {
"description": "Internal server error"
}
}
}
}
app/swagger/paths/RevokeEnableConsent.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"RevokeEnableConsent"
],
"summary": "Revoke Enable Consent Request",
"description": "Revoke Enable Consent Request",
"operationId": "RevokeEnableConsent",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/RevokeEnableConsentRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/RevokeEnableConsentRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/RevokeEnableConsentRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "RevokeEnableConsent Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/RevokeEnableConsentResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/RevokeEnableConsentResponse.json"
}
}
}
},
"400": {
"description": "Invalid request parameters"
},
"500": {
"description": "Internal server error"
}
}
}
}
app/swagger/paths/TokenValidation.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"TokenValidation"
],
"summary": "Token Validation Request",
"description": "Token Validation Request",
"operationId": "TokenValidation",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/TokenValidationRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/TokenValidationRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/TokenValidationRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "TokenValidation Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/TokenValidationResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/TokenValidationResponse.json"
}
}
}
},
"400": {
"description": "Invalid request parameters"
},
"500": {
"description": "Internal server error"
}
}
}
}
app/swagger/paths/TransactionVerify.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"TransactionVerify"
],
"summary": "Transaction Verify Request",
"description": "Transaction Verify Request",
"operationId": "TransactionVerify",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/TransactionVerifyRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/TransactionVerifyRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/TransactionVerifyRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "TransactionVerify Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/TransactionVerifyResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/TransactionVerifyResponse.json"
}
}
}
},
"400": {
"description": "Invalid request parameters"
},
"500": {
"description": "Internal server error"
}
}
}
}