-
Notifications
You must be signed in to change notification settings - Fork 917
/
swagger.yaml
166 lines (166 loc) · 3.8 KB
/
swagger.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
swagger: '2.0'
info:
title: Bank Argent API documentation
description: Contains all available API endpoints in this codebase
version: '1.0.0'
termsOfService: 'http://swagger.io/terms/'
host: localhost:3001
basePath: /api/v1
schemes:
- http
paths:
/user/login:
post:
tags:
- User Module
summary: Login
description: API for Login
parameters:
- in: body
name: body
description: Login Payload
required: true
schema:
$ref: '#/definitions/Login'
produces:
- application/json
responses:
'200':
description: Login Successfully
schema:
$ref: '#/definitions/LoginResponse'
'400':
description: Invalid Fields
'500':
description: Internal Server Error
/user/signup:
post:
tags:
- User Module
summary: Signup
description: API for Signup
parameters:
- in: body
name: body
description: Signup Payload
required: true
schema:
$ref: '#/definitions/User'
produces:
- application/json
responses:
'200':
description: Signup Successfully
schema:
$ref: '#/definitions/ApiResponse'
'400':
description: Invalid Fields
'500':
description: Internal Server Error
/user/profile:
post:
security:
- Bearer: []
tags:
- User Module
summary: User Profile API
description: API for fetching a user profile
parameters:
- in: header
name: Authorization
description: Attach Bearer JWT token
required: true
produces:
- application/json
responses:
'200':
description: User profile retrieved successully
schema:
$ref: '#/definitions/ApiResponse'
'400':
description: Invalid Fields
'500':
description: Internal Server Error
put:
security:
- Bearer: []
tags:
- User Module
summary: User Profile API
description: API for updating a user profile
parameters:
- in: header
name: Authorization
description: Attach Bearer JWT token
required: true
- in: body
name: body
description: Update user profile attributes
required: true
schema:
$ref: '#/definitions/UserProfile'
produces:
- application/json
responses:
'200':
description: User profile retrieved successully
schema:
$ref: '#/definitions/ApiResponse'
'400':
description: Invalid Fields
'500':
description: Internal Server Error
securityDefinitions:
Bearer:
type: apiKey
name: Authorization
in: header
definitions:
User:
properties:
email:
type: string
description: user email
password:
type: string
description: user password
firstName:
type: string
description: user first name
lastName:
type: string
description: user last name
Login:
properties:
email:
type: string
description: user email
password:
type: string
description: user password
ApiResponse:
type: object
properties:
status:
type: integer
message:
type: string
body:
type: object
properties:
id:
type: string
email:
type: string
LoginResponse:
type: object
properties:
token:
type: string
UserProfile:
type: object
properties:
firstName:
type: string
lastName:
type: string