Updated Docs

This commit is contained in:
Azeez Muibi
2025-03-26 14:48:32 +01:00
parent 9ed359d307
commit 183c1bf46f
59 changed files with 2513 additions and 390 deletions
+159 -82
View File
@@ -15,10 +15,50 @@
},
"servers": [
{
"url": "http://localhost:6337"
"url": "https://devcore.digifi.chiefsoft.net/v1/api/salary"
}
],
"tags": [
{
"name": "EligibilityCheck",
"description": "Eligibility Check Request",
"externalDocs": {
"description": "Find out more",
"url": "https://www.simbrellang.net"
}
},
{
"name": "SelectOffer",
"description": "This method is used the send the offer the customer selected to Simbrella.",
"externalDocs": {
"description": "Find out more",
"url": "https://www.simbrellang.net"
}
},
{
"name": "ProvideLoan",
"description": "Provide Loan Request.",
"externalDocs": {
"description": "Find out more",
"url": "https://www.simbrellang.net"
}
},
{
"name": "LoanStatus",
"description": "Loan Status Request.",
"externalDocs": {
"description": "Find out more",
"url": "https://www.simbrellang.net"
}
},
{
"name": "Repayment",
"description": "Repayment Request.",
"externalDocs": {
"description": "Find out more",
"url": "https://www.simbrellang.net"
}
},
{
"name": "RACCheck",
"description": "Risk Acceptance Criteria Request",
@@ -59,22 +99,6 @@
"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",
@@ -84,8 +108,24 @@
}
},
{
"name": "NewTransactionCheck",
"description": "New Transaction Check",
"name": "StatusCall",
"description": "Status Call",
"externalDocs": {
"description": "Find out more",
"url": "https://www.simbrellang.net"
}
},
{
"name": "SMS",
"description": "SMSRequest",
"externalDocs": {
"description": "Find out more",
"url": "https://www.simbrellang.net"
}
},
{
"name": "BulkSMS",
"description": "Bulk SMS Request",
"externalDocs": {
"description": "Find out more",
"url": "https://www.simbrellang.net"
@@ -93,119 +133,156 @@
}
],
"paths": {
"/EligibilityCheck": {
"$ref": "./paths/EligibilityCheck.json"
},
"/SelectOffer": {
"$ref": "./paths/SelectOffer.json"
},
"/ProvideLoan": {
"$ref": "./paths/ProvideLoan.json"
},
"/LoanStatus": {
"$ref": "./paths/LoanStatus.json"
},
"/Repayment": {
"$ref": "./paths/Repayment.json"
},
"/RACCheck": {
"$ref": "swagger/paths/RACCheck.json"
"$ref": "./paths/RACCheck.json"
},
"/Disbursement": {
"$ref": "swagger/paths/Disbursement.json"
"$ref": "./paths/Disbursement.json"
},
"/CollectLoan": {
"$ref": "swagger/paths/CollectLoan.json"
"$ref": "./paths/CollectLoan.json"
},
"/TransactionVerify": {
"$ref": "swagger/paths/TransactionVerify.json"
"$ref": "./paths/TransactionVerify.json"
},
"/PenalCharge": {
"$ref": "swagger/paths/PenalCharge.json"
},
"/RevokeEnableConsent": {
"$ref": "swagger/paths/RevokeEnableConsent.json"
},
"/TokenValidation": {
"$ref": "swagger/paths/TokenValidation.json"
"$ref": "./paths/PenalCharge.json"
},
"/LienCheck": {
"$ref": "swagger/paths/LienCheck.json"
"$ref": "./paths/LienCheck.json"
},
"/NewTransactionCheck": {
"$ref": "swagger/paths/NewTransactionCheck.json"
"/StatusCall": {
"$ref": "./paths/StatusCall.json"
},
"/SMS": {
"$ref": "./paths/SMS.json"
},
"/BulkSMS": {
"$ref": "./paths/BulkSMS.json"
}
},
"components": {
"schemas": {
"EligibilityCheckRequest": {
"$ref": "./schemas/EligibilityCheckRequest.json"
},
"EligibilityCheckResponse": {
"$ref": "./schemas/EligibilityCheckResponse.json"
},
"SelectOfferRequest": {
"$ref": "./schemas/SelectOfferRequest.json"
},
"SelectOfferResponse": {
"$ref": "./schemas/SelectOfferResponse.json"
},
"LoanStatusRequest": {
"$ref": "./schemas/LoanStatusRequest.json"
},
"LoanStatusResponse": {
"$ref": "./schemas/LoanStatusResponse.json"
},
"RepaymentRequest": {
"$ref": "./schemas/RepaymentRequest.json"
},
"RepaymentResponse": {
"$ref": "./schemas/RepaymentResponse.json"
},
"RACCheckRequest": {
"$ref": "swagger/schemas/RACCheckRequest.json"
"$ref": "./schemas/RACCheckRequest.json"
},
"RACCheckResponse": {
"$ref": "swagger/schemas/RACCheckResponse.json"
},
"CustomerConsentRequest": {
"$ref": "swagger/schemas/CustomerConsentRequest.json"
},
"CustomerConsentResponse": {
"$ref": "swagger/schemas/CustomerConsentResponse.json"
"$ref": "./schemas/RACCheckResponse.json"
},
"DisbursementRequest": {
"$ref": "swagger/schemas/DisbursementRequest.json"
"$ref": "./schemas/DisbursementRequest.json"
},
"DisbursementResponse": {
"$ref": "swagger/schemas/DisbursementResponse.json"
"$ref": "./schemas/DisbursementResponse.json"
},
"CollectLoanRequest": {
"$ref": "swagger/schemas/CollectLoanRequest.json"
"$ref": "./schemas/CollectLoanRequest.json"
},
"CollectLoanResponse": {
"$ref": "swagger/schemas/CollectLoanResponse.json"
"$ref": "./schemas/CollectLoanResponse.json"
},
"TransactionVerifyRequest": {
"$ref": "swagger/schemas/TransactionVerifyRequest.json"
"$ref": "./schemas/TransactionVerifyRequest.json"
},
"TransactionVerifyResponse": {
"$ref": "swagger/schemas/TransactionVerifyResponse.json"
"$ref": "./schemas/TransactionVerifyResponse.json"
},
"PenalChargeRequest": {
"$ref": "swagger/schemas/PenalChargeRequest.json"
"$ref": "./schemas/PenalChargeRequest.json"
},
"PenalChargeResponse": {
"$ref": "swagger/schemas/PenalChargeResponse.json"
"$ref": "./schemas/PenalChargeResponse.json"
},
"RevokeEnableConsentRequest": {
"$ref": "swagger/schemas/RevokeEnableConsentRequest.json"
"StatusCallRequest": {
"$ref": "./schemas/StatusCallRequest.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"
"StatusCallResponse": {
"$ref": "./schemas/StatusCallResponse.json"
},
"LienCheckRequest": {
"$ref": "swagger/schemas/LienCheckRequest.json"
"$ref": "./schemas/LienCheckRequest.json"
},
"LienCheckResponse": {
"$ref": "swagger/schemas/LienCheckResponse.json"
"$ref": "./schemas/LienCheckResponse.json"
},
"SMSRequest": {
"$ref": "./schemas/SMSRequest.json"
},
"SMSResponse": {
"$ref": "./schemas/SMSResponse.json"
},
"BulkSMSRequest": {
"$ref": "./schemas/BulkSMSRequest.json"
},
"BulkSMSResponse": {
"$ref": "./schemas/BulkSMSResponse.json"
},
"ApiResponse": {
"$ref": "swagger/schemas/ApiResponse.json"
"$ref": "./schemas/ApiResponse.json"
}
},
"securitySchemes": {
"petstore_auth": {
"type": "oauth2",
"flows": {
"implicit": {
"authorizationUrl": "https://petstore3.swagger.io/oauth/authorize",
"scopes": {
"write:pets": "modify pets in your account",
"read:pets": "read your pets"
}
}
}
},
"api_key": {
"type": "apiKey",
"name": "x-api-key",
"name": "api_key",
"in": "header"
},
"app_id": {
"type": "apiKey",
"name": "App-Id",
"in": "header"
"basic_auth": {
"type": "http",
"scheme": "basic",
"description": "Basic authentication with username and password"
}
}
},
"security": [
{
"api_key": []
},
{
"app_id": []
}
]
}
}