-
Notifications
You must be signed in to change notification settings - Fork 5
/
swagger.yml
92 lines (88 loc) · 2 KB
/
swagger.yml
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
swagger: '2.0'
info:
description: A simple international travel request API
version: 1.0.0
title: Barefoot Nomad API
schemes:
- https
# host: barefootNomad.com
# basePath: /v1
securityDefinitions:
UserSecurity:
type: basic
security:
- UserSecurity: []
paths:
/auth/signup:
post:
description: Users can sign up
responses:
200:
description: User successfully signed up
schema:
type: object
required:
- first_name
- last_name
- email
- password
properties:
status:
type: string
data:
type: object
properties:
user_id:
type: integer
token:
type: string
400:
description: Invalid request
schema:
type: object
properties:
status:
type: string
error:
type: string
/**
* @swagger
* components:
* schemas:
* User:
* properties:
* first_name:
* type: string
* last_name:
* type: string
* address:
* type: string
* preferred_lang:
* type: string
* preferred_currency:
* type: string
* gender:
* type: string
*/
/**
* @swagger
* /api/v1/profile:
* put:
* tags:
* - Users
* description: Update user profile
* produces:
* - application/json
* requestBody:
* description: User data object
* required: true
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/User'
* responses:
* 200:
* description: Profile updated successfully
* 500:
* description: Internal Server error
*/