-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathAPI-Documentation.yaml
150 lines (129 loc) · 2.98 KB
/
API-Documentation.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
openapi: "3.0.1"
info:
description: 'Api Documentation for Hotel Management System'
version: 1.0.0
title: Api Documentation for Hotel Management System
tags:
- name: staff
description: Staff information
- name: user
description: Users information
- name: roles
description: Roles Route
paths:
/staff:
get:
tags:
- staff
summary: Staff information
description: Get Work Staff information
operationId: staff
responses:
'200':
description: OK
/login:
post:
tags:
- user
summary: Login request
description: Login
operationId: login
requestBody:
content:
multipart/form-data:
schema:
type: object
required:
- email
- password
properties:
email:
type: string
format: email
password:
type: string
password-confirm:
type: string
responses:
'401':
description: Incorrect Data.
'200':
description: OK
/register:
post:
tags:
- user
summary: register
description: register
operationId: register
requestBody:
content:
multipart/form-data:
schema:
type: object
required:
- name
- email
- password
- password-confirm
- phone_number
- country
- city
properties:
name:
type: string
email:
type: string
format: email
password:
type: string
password-confirm:
type: string
phone_number:
type: number
country:
type: string
city:
type: string
address:
type: string
VIP:
type: boolean
responses:
'201':
description: Created successfully
'200':
description: OK
/logout:
post:
tags:
- user
summary: logout
description: logout
operationId: logout
responses:
'205':
description: User Logout successfully
'401':
description: You Should Login first to perform this process
security:
- bearerAuth: []
/roles:
get:
tags:
- roles
summary: Roles information
description: Get role list information
operationId: roles
responses:
'200':
description: OK
security:
- bearerAuth: []
servers:
- url: http://127.0.0.1:8000/api
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer