-
Notifications
You must be signed in to change notification settings - Fork 0
/
api_definitions.yaml
276 lines (247 loc) · 7.04 KB
/
api_definitions.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
GET /api/data:
method: GET
path: /api/data
response:
message: "Mock data fetched successfully!"
statusCode: 200
POST /api/data:
method: POST
path: /api/data
response:
message: "Mock data posted successfully!"
statusCode: 201
GET /api/defaults:
method: GET
path: /api/defaults
response:
defaults:
-
name: rate (percentage)
type: string
value: 20
-
name: charges (inr)
type: number
value: 589.50
GET /api/test:
method: GET
path: /api/test
response:
json:
- rigid
- better for data interchange
yaml:
- slim and flexible
- better for configuration
object:
key: value
array:
- null_value: null
- boolean: true
- integer: 1
- alias: aliases are like variables
- alias: aliases are like variables
paragraph: |
Blank lines denote
paragraph breaks
content: |-
Or we
can auto
convert line breaks
to save space
alias:
bar: baz
alias_reuse:
bar: baz
# route for getting users and their experience
GET /api/asas:
method: GET
path: /api/asas
response:
-
serialNo: 1
firstName: Akash
lastName: Karar
gender: Male
exp:
-
companyName: AIPL
years: 3
-
serialNo: 2
firstName: Nilesh
lastName: Suthar
gender: Male
exp:
-
companyName: AIPL
years: 2.5
# route for getting repayment schedule as part of kfs
GET /api/get-repayment-schedule:
method: GET
path: /api/asas
response:
repayment_schedule:
- payment_number: 1
payment_date: "2023-01-01"
principal_payment: 150.00
interest_payment: 45.00
total_payment: 195.00
remaining_balance: 9850.00
interest_rate: "5.00%"
additional_fees: 10.00
prepayment_amount: 0.00
- payment_number: 2
payment_date: "2023-02-01"
principal_payment: 155.00
interest_payment: 41.25
total_payment: 196.25
remaining_balance: 9695.00
interest_rate: "5.00%"
additional_fees: 10.00
prepayment_amount: 0.00
- payment_number: 3
payment_date: "2023-03-01"
principal_payment: 160.00
interest_payment: 37.00
total_payment: 197.00
remaining_balance: 9535.00
interest_rate: "5.00%"
additional_fees: 10.00
prepayment_amount: 0.00
- payment_number: 4
payment_date: "2023-04-01"
principal_payment: 165.00
interest_payment: 32.75
total_payment: 197.75
remaining_balance: 9370.00
interest_rate: "5.00%"
additional_fees: 10.00
prepayment_amount: 0.00
- payment_number: 5
payment_date: "2023-05-01"
principal_payment: 170.00
interest_payment: 28.00
total_payment: 198.00
remaining_balance: 9200.00
interest_rate: "5.00%"
additional_fees: 10.00
prepayment_amount: 0.00
- payment_number: 6
payment_date: "2023-06-01"
principal_payment: 175.00
interest_payment: 23.25
total_payment: 198.25
remaining_balance: 9025.00
interest_rate: "5.00%"
additional_fees: 10.00
prepayment_amount: 0.00
- payment_number: 7
payment_date: "2023-07-01"
principal_payment: 180.00
interest_payment: 18.00
total_payment: 198.00
remaining_balance: 8845.00
interest_rate: "5.00%"
additional_fees: 10.00
prepayment_amount: 0.00
- payment_number: 8
payment_date: "2023-08-01"
principal_payment: 185.00
interest_payment: 12.75
total_payment: 197.75
remaining_balance: 8660.00
interest_rate: "5.00%"
additional_fees: 10.00
prepayment_amount: 0.00
- payment_number: 9
payment_date: "2023-09-01"
principal_payment: 190.00
interest_payment: 7.00
total_payment: 197.00
remaining_balance: 8470.00
interest_rate: "5.00%"
additional_fees: 10.00
prepayment_amount: 0.00
- payment_number: 10
payment_date: "2023-10-01"
principal_payment: 195.00
interest_payment: 1.75
total_payment: 196.75
remaining_balance: 8275.00
interest_rate: "5.00%"
additional_fees: 10.00
prepayment_amount: 0.00
- payment_number: 11
payment_date: "2023-11-01"
principal_payment: 200.00
interest_payment: 0.00
total_payment: 200.00
remaining_balance: 8075.00
interest_rate: "5.00%"
additional_fees: 10.00
prepayment_amount: 0.00
- payment_number: 12
payment_date: "2023-12-01"
principal_payment: 205.00
interest_payment: 0.00
total_payment: 205.00
remaining_balance: 787
- payment_number: 12
payment_date: "2023-12-01"
principal_payment: 205.00
interest_payment: 0.00
total_payment: 205.00
remaining_balance: 7870.00
interest_rate: "5.00%"
additional_fees: 10.00
prepayment_amount: 0.00
- payment_number: 13
payment_date: "2024-01-01"
principal_payment: 210.00
interest_payment: 0.00
total_payment: 210.00
remaining_balance: 7660.00
interest_rate: "5.00%"
additional_fees: 10.00
prepayment_amount: 0.00
- payment_number: 14
payment_date: "2024-02-01"
principal_payment: 215.00
interest_payment: 0.00
total_payment: 215.00
remaining_balance: 7445.00
interest_rate: "5.00%"
additional_fees: 10.00
prepayment_amount: 0.00
- payment_number: 15
payment_date: "2024-03-01"
principal_payment: 220.00
interest_payment: 0.00
total_payment: 220.00
remaining_balance: 7225.00
interest_rate: "5.00%"
additional_fees: 10.00
prepayment_amount: 0.00
- payment_number: 16
payment_date: "2024-04-01"
principal_payment: 225.00
interest_payment: 0.00
total_payment: 225.00
remaining_balance: 7000.00
interest_rate: "5.00%"
additional_fees: 10.00
prepayment_amount: 0.00
# Explanation of the YAML Structure
# Each entry in the repayment_schedule list represents a payment.
# Each payment entry includes:
# payment_number: The sequential number of the payment.
# payment_date: The date the payment is due.
# principal_payment: The amount applied to the principal balance.
# interest_payment: The amount applied to interest.
# total_payment: The total amount paid in that installment.
# remaining_balance: The outstanding balance after the payment.
# interest_rate: The interest rate applied to the loan.
# additional_fees: Any additional fees associated with the payment.
# prepayment_amount: Any additional amount paid toward the principal beyond the scheduled payment.
# Feel free to modify any values as needed!