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": [
"ProvideLoan"
],
"summary": "Provide Loan Request ",
"description": "Provide Loan Request",
"operationId": "startEligibilityCheck",
"summary": "Provide Loan Request",
"description": "This endpoint is used by FirstBank to request a loan provision for a customer. It allows FirstBank to specify the loan details including the amount, collection type, and loan type.",
"operationId": "provideLoan",
"requestBody": {
"description": "Post JSON to conduct eligibility tests",
"description": "Loan provision request details",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/EligibilityCheckRequest.json"
"$ref": "../schemas/ProvideLoanRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/EligibilityCheckRequest.json"
"$ref": "../schemas/ProvideLoanRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/EligibilityCheckRequest.json"
"$ref": "../schemas/ProvideLoanRequest.json"
}
}
},
@@ -29,37 +29,31 @@
},
"responses": {
"200": {
"description": "Successful operation",
"description": "Loan provision request processed successfully",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/EligibilityCheckResponse.json"
"$ref": "../schemas/ProvideLoanResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/EligibilityCheckResponse.json"
"$ref": "../schemas/ProvideLoanResponse.json"
}
}
}
},
"400": {
"description": "Invalid ID supplied"
"description": "Invalid request"
},
"404": {
"description": "Pet not found"
},
"422": {
"description": "Validation exception"
"500": {
"description": "Internal server error"
}
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
"basic_auth": []
}
]
}
}
}