Updated Swagger Documentation

This commit is contained in:
Azeez Muibi
2025-03-24 15:15:31 +01:00
parent 67dfc32e4a
commit 9684d6dd29
56 changed files with 1344 additions and 349 deletions
+15 -21
View File
@@ -3,25 +3,25 @@
"tags": [
"NotificationCallback"
],
"summary": "Loan Information Request ",
"description": "Loan Information Request",
"operationId": "startEligibilityCheck",
"summary": "Notification Callback",
"description": "This new feature will be used for informing Simbrella about status of the transactions that FBN have processed. Retry mechanism should be implemented by FirstBank in case of connection issues, sending notification should be repeated for 5 minutes in case of there is connection issues, after which Simbrella will try to check the status of transaction with New Transaction Check endpoint. FBN should provide a list of Response Codes with corresponding Response Descriptions for notifications. Please note that AmountCollected field will equal to 0 when transaction type is Disbursement. AmountProvided field will equal to 0 when transaction type is Collection or PenalCharge.",
"operationId": "notificationCallback",
"requestBody": {
"description": "Post JSON to conduct eligibility tests",
"description": "Transaction status notification from FirstBank to Simbrella",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/LoanInformationRequest.json"
"$ref": "../schemas/NotificationCallbackRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/LoanInformationRequest.json"
"$ref": "../schemas/NotificationCallbackRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/LoanInformationRequest.json"
"$ref": "../schemas/NotificationCallbackRequest.json"
}
}
},
@@ -29,37 +29,31 @@
},
"responses": {
"200": {
"description": "Successful operation",
"description": "Notification received successfully",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/LoanInformationResponse.json"
"$ref": "../schemas/NotificationCallbackResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/LoanInformationResponse.json"
"$ref": "../schemas/NotificationCallbackResponse.json"
}
}
}
},
"400": {
"description": "Invalid ID supplied"
"description": "Invalid request"
},
"404": {
"description": "Loan not found"
},
"422": {
"description": "Validation exception"
"500": {
"description": "Internal server error"
}
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
"basic_auth": []
}
]
}
}
}