2020 - name : Edit Profile
2121 - name : Report Profile
2222 - name : View Profile
23-
2423 - name : Like
2524 description : Like, unlike user etc...
2625 - name : Match
6160 type : boolean
6261 description : If the request is a success
6362 example : true
64- status_code :
63+ code :
6564 type : integer
6665 description : The status code
6766 example : 200
@@ -71,10 +70,67 @@ paths:
7170 example : foo@example.org
7271 " 409 " :
7372 $ref : ' #/components/responses/Conflict'
73+ " 400 " :
74+ $ref : ' #/components/responses/BadRequest'
75+ /auth/login :
76+ post :
77+ tags :
78+ - Authentication
79+ summary : Login to Matcha
80+ description : " "
81+ operationId : loginUser
82+ # security:
83+ # - bearerAuth: []
84+ requestBody :
85+ description : Parameters to login a user. Either email or username
86+ required : true
87+ content :
88+ application/json :
89+ schema :
90+ $ref : ' #/components/schemas/LoginUser'
91+ responses :
92+ " 200 " :
93+ description : User successfully logged in
94+ content :
95+ application/json :
96+ schema :
97+ type : object
98+ properties :
99+ success :
100+ type : boolean
101+ description : If the request is a success
102+ example : true
103+ code :
104+ type : integer
105+ description : The status code
106+ example : 200
107+ return :
108+ type : object
109+ properties :
110+ access_token :
111+ type : string
112+ description : The user access token to use in bearer auth
113+ example : eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MDAyODM3NDAsIm5iZiI6MTYwMDI4Mzc0MCwianRpIjoiMTFlMmFhNzMtYWVkOS00NDQ2LWExNWItODAxZmFmYjYzYTdiIiwiZXhwIjoxNjAwMjg0NjQwLCJpZGVudGl0eSI6eyJpZCI6MSwiZW1haWwiOiJmb29AZXhhbXBsZS5vcmciLCJ1c2VybmFtZSI6ImZvbyIsImlzX29ubGluZSI6MCwiZGF0ZV9sYXN0c2VlbiI6IldlZCwgMTYgU2VwIDIwMjAgMTU6Mzk6MDQgR01UIn0sImZyZXNoIjp0cnVlLCJ0eXBlIjoiYWNjZXNzIn0.EFCIlsxSbEeHza_U9oPdVvvfx1rquItHDnoYtP19XBM
114+ refresh_token :
115+ type : string
116+ description : The user refresh token usd to refresh the access token when expired
117+ example : eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MDAyODM3NDAsIm5iZiI6MTYwMDI4Mzc0MCwianRpIjoiNWQ2NjYwMTQtMDJkMi00YjY4LThjOTktNDQwNDZjYzYzZDNjIiwiZXhwIjoxNjAyODc1NzQwLCJpZGVudGl0eSI6eyJpZCI6MSwiZW1haWwiOiJmb29AZXhhbXBsZS5vcmciLCJ1c2VybmFtZSI6ImZvbyIsImlzX29ubGluZSI6MCwiZGF0ZV9sYXN0c2VlbiI6IldlZCwgMTYgU2VwIDIwMjAgMTU6Mzk6MDQgR01UIn0sInR5cGUiOiJyZWZyZXNoIn0.yz1QhL1QhxUdYvvacXZ0CkkVxFp2CkcNYpYRtKdRXdo
118+ is_profile_completed :
119+ type : boolean
120+ description : Is the user profile completed
121+ example : false
122+ " 409 " :
123+ $ref : ' #/components/responses/Conflict'
124+ " 400 " :
125+ $ref : ' #/components/responses/BadRequest'
126+ " 401 " :
127+ $ref : ' #/components/responses/Unauthorized'
128+
74129
75130servers :
76131 - url : https://api.matcha.com
77132
133+
78134components :
79135 responses :
80136 Conflict :
@@ -190,4 +246,15 @@ components:
190246 example : Foo
191247 last_name :
192248 type : string
193- example : Bar
249+ example : Bar
250+ LoginUser :
251+ type : object
252+ properties :
253+ username :
254+ type : string
255+ example : foo@example.org
256+ required : true
257+ password :
258+ type : string
259+ example : dolphin2
260+ required : true
0 commit comments