[add]: Swagger Documentation

2025-03-24 08:44:57 +01:00
parent 7a4a9a9b99
commit dad8e68c9f
72 changed files with 1679 additions and 66 deletions
@@ -0,0 +1,211 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Swagger Simbrella FirstAdvance - OpenAPI 3.0",
+    "description": "This is a Simbrella FirstAdvance Backend Server with the OpenAPI 3.0 specification.  \n\n\nSome useful links:\n- [Web Simulated Demo Page](https://digifi-salaryloan.chiefsoft.net/)\n- [Web Management Support Portal](https://digifi-office.chiefsoft.net/auth/login)",
+    "termsOfService": "http://swagger.io/terms/",
+    "contact": {
+      "email": "support@chiefsoft.com"
+    },
+    "license": {
+      "name": "Apache 2.0",
+      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
+    },
+    "version": "1.0.11"
+  },
+  "servers": [
+    {
+      "url": "http://localhost:6337"
+    }
+  ],
+  "tags": [
+    {
+      "name": "RACCheck",
+      "description": "Risk Acceptance Criteria Request",
+      "externalDocs": {
+        "description": "Find out more",
+        "url": "https://www.simbrellang.net"
+      }
+    },
+    {
+      "name": "Disbursement",
+      "description": "Loan Disbursement Request",
+      "externalDocs": {
+        "description": "Find out more",
+        "url": "https://www.simbrellang.net"
+      }
+    },
+    {
+      "name": "CollectLoan",
+      "description": "Collect Loan Request",
+      "externalDocs": {
+        "description": "Find out more",
+        "url": "https://www.simbrellang.net"
+      }
+    },
+    {
+      "name": "TransactionVerify",
+      "description": "Transaction Verify Request",
+      "externalDocs": {
+        "description": "Find out more",
+        "url": "https://www.simbrellang.net"
+      }
+    },
+    {
+      "name": "PenalCharge",
+      "description": "Penal Charge Request",
+      "externalDocs": {
+        "description": "Find out more",
+        "url": "https://www.simbrellang.net"
+      }
+    },
+    {
+      "name": "RevokeEnableConsent",
+      "description": "Revoke Enable Consent Request",
+      "externalDocs": {
+        "description": "Find out more",
+        "url": "https://www.simbrellang.net"
+      }
+    },
+    {
+      "name": "TokenValidation",
+      "description": "Token Validation",
+      "externalDocs": {
+        "description": "Find out more",
+        "url": "https://www.simbrellang.net"
+      }
+    },
+    {
+      "name": "LienCheck",
+      "description": "Lien Check",
+      "externalDocs": {
+        "description": "Find out more",
+        "url": "https://www.simbrellang.net"
+      }
+    },
+    {
+      "name": "NewTransactionCheck",
+      "description": "New Transaction Check",
+      "externalDocs": {
+        "description": "Find out more",
+        "url": "https://www.simbrellang.net"
+      }
+    }
+  ],
+  "paths": {
+    "/RACCheck": {
+      "$ref": "swagger/paths/RACCheck.json"
+    },
+    "/Disbursement": {
+      "$ref": "swagger/paths/Disbursement.json"
+    },
+    "/CollectLoan": {
+      "$ref": "swagger/paths/CollectLoan.json"
+    },
+    "/TransactionVerify": {
+      "$ref": "swagger/paths/TransactionVerify.json"
+    },
+    "/PenalCharge": {
+      "$ref": "swagger/paths/PenalCharge.json"
+    },
+    "/RevokeEnableConsent": {
+      "$ref": "swagger/paths/RevokeEnableConsent.json"
+    },
+    "/TokenValidation": {
+      "$ref": "swagger/paths/TokenValidation.json"
+    },
+    "/LienCheck": {
+      "$ref": "swagger/paths/LienCheck.json"
+    },
+    "/NewTransactionCheck": {
+      "$ref": "swagger/paths/NewTransactionCheck.json"
+    }
+  },
+  "components": {
+    "schemas": {
+      "RACCheckRequest": {
+        "$ref": "swagger/schemas/RACCheckRequest.json"
+      },
+      "RACCheckResponse": {
+        "$ref": "swagger/schemas/RACCheckResponse.json"
+      },
+      "CustomerConsentRequest": {
+        "$ref": "swagger/schemas/CustomerConsentRequest.json"
+      },
+      "CustomerConsentResponse": {
+        "$ref": "swagger/schemas/CustomerConsentResponse.json"
+      },
+      "DisbursementRequest": {
+        "$ref": "swagger/schemas/DisbursementRequest.json"
+      },
+      "DisbursementResponse": {
+        "$ref": "swagger/schemas/DisbursementResponse.json"
+      },
+      "CollectLoanRequest": {
+        "$ref": "swagger/schemas/CollectLoanRequest.json"
+      },
+      "CollectLoanResponse": {
+        "$ref": "swagger/schemas/CollectLoanResponse.json"
+      },
+      "TransactionVerifyRequest": {
+        "$ref": "swagger/schemas/TransactionVerifyRequest.json"
+      },
+      "TransactionVerifyResponse": {
+        "$ref": "swagger/schemas/TransactionVerifyResponse.json"
+      },
+      "PenalChargeRequest": {
+        "$ref": "swagger/schemas/PenalChargeRequest.json"
+      },
+      "PenalChargeResponse": {
+        "$ref": "swagger/schemas/PenalChargeResponse.json"
+      },
+      "RevokeEnableConsentRequest": {
+        "$ref": "swagger/schemas/RevokeEnableConsentRequest.json"
+      },
+      "RevokeEnableConsentResponse": {
+        "$ref": "swagger/schemas/RevokeEnableConsentResponse.json"
+      },
+      "TokenValidationRequest": {
+        "$ref": "swagger/schemas/TokenValidationRequest.json"
+      },
+      "TokenValidationResponse": {
+        "$ref": "swagger/schemas/TokenValidationResponse.json"
+      },
+      "NewTransactionCheckRequest": {
+        "$ref": "swagger/schemas/NewTransactionCheckRequest.json"
+      },
+      "NewTransactionCheckResponse": {
+        "$ref": "swagger/schemas/NewTransactionCheckResponse.json"
+      },
+      "LienCheckRequest": {
+        "$ref": "swagger/schemas/LienCheckRequest.json"
+      },
+      "LienCheckResponse": {
+        "$ref": "swagger/schemas/LienCheckResponse.json"
+      },
+      "ApiResponse": {
+        "$ref": "swagger/schemas/ApiResponse.json"
+      }
+    },
+    "securitySchemes": {
+      "api_key": {
+        "type": "apiKey",
+        "name": "x-api-key",
+        "in": "header"
+      },
+      "app_id": {
+        "type": "apiKey",
+        "name": "App-Id",
+        "in": "header"
+      }
+    }
+  },
+  "security": [
+    {
+      "api_key": []
+    },
+    {
+      "app_id": []
+    }
+  ]
+}