lennyaiko
166 lines
4.6 KiB
YAML
166 lines
4.6 KiB
YAML
openapi: 3.0.3
|
|
info:
|
|
title: Sample Flask API
|
|
description: A simple Flask API with Swagger documentation running in Docker
|
|
version: 1.0.0
|
|
contact:
|
|
name: API Support
|
|
email: support@example.com
|
|
license:
|
|
name: MIT
|
|
url: https://opensource.org/licenses/MIT
|
|
|
|
servers:
|
|
- url: http://localhost:5000
|
|
description: Local development server
|
|
|
|
paths:
|
|
/health:
|
|
get:
|
|
summary: Returns a health message
|
|
responses:
|
|
200:
|
|
description: A successful response
|
|
/eligibility/check:
|
|
post:
|
|
summary: Performs eligibility check on a user
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
transactionId:
|
|
type: string
|
|
description: The transaction ID
|
|
example: Tr201712RK9232P115
|
|
customerId:
|
|
type: string
|
|
description: The customer ID
|
|
example: CN621868
|
|
countryCode:
|
|
type: string
|
|
description: The country code
|
|
example: NGR
|
|
accountId:
|
|
type: string
|
|
description: The account ID
|
|
example: ACN8263457
|
|
msisdn:
|
|
type: string
|
|
description: The MSISDN
|
|
example: 8012345678
|
|
channel:
|
|
type: string
|
|
description: The channel
|
|
example: 100
|
|
responses:
|
|
200:
|
|
description: A successful response
|
|
/loans/select-offer:
|
|
post:
|
|
summary: Selects an offer for a loan
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
requestId:
|
|
type: string
|
|
example: "202111170001371256908"
|
|
transactionId:
|
|
type: string
|
|
example: "1231231321232"
|
|
customerId:
|
|
type: string
|
|
example: "1256907"
|
|
accountId:
|
|
type: string
|
|
example: "5948306019"
|
|
msisdn:
|
|
type: string
|
|
example: "123456789"
|
|
requestedAmount:
|
|
type: integer
|
|
example: 10000
|
|
productId:
|
|
type: string
|
|
example: "101"
|
|
channel:
|
|
type: string
|
|
example: "USSD"
|
|
responses:
|
|
200:
|
|
description: A successful response
|
|
/loans/provide-loan:
|
|
post:
|
|
summary: Provides a loan
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
requestId:
|
|
type: string
|
|
example: "202111170001371256908"
|
|
transactionId:
|
|
type: string
|
|
example: "Tr201712RK9232P115"
|
|
customerId:
|
|
type: string
|
|
example: "CN621868"
|
|
accountId:
|
|
type: string
|
|
example: "ACN8263457"
|
|
msisdn:
|
|
type: string
|
|
example: "3451342"
|
|
productId:
|
|
type: string
|
|
example: "101"
|
|
requestedAmount:
|
|
type: integer
|
|
example: 900
|
|
collectionType:
|
|
type: integer
|
|
example: 1
|
|
offerId:
|
|
type: integer
|
|
example: 1127
|
|
channel:
|
|
type: string
|
|
example: "100"
|
|
responses:
|
|
200:
|
|
description: A successful response
|
|
/loans/status:
|
|
post:
|
|
summary: Returns the status of a loan
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
transactionId:
|
|
type: string
|
|
example: "Tr201712RK9232P115"
|
|
customerId:
|
|
type: string
|
|
example: "CN621868"
|
|
msisdn:
|
|
type: string
|
|
example: "3451342"
|
|
channel:
|
|
type: string
|
|
example: "100"
|
|
responses:
|
|
200:
|
|
description: A successful response
|