forked from KenzieAcademy/kwitter-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
specification.yaml
87 lines (87 loc) · 1.99 KB
/
specification.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
openapi: 3.0.1
info:
title: Kwitter
version: "1.0.0"
servers:
- url: http://localhost:3000
description: localhost
- url: https://kwitter-api.herokuapp.com
description: Production Server
paths:
/auth/login:
post:
summary: Login user
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
username:
type: string
password:
type: string
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
id:
type: integer
token:
type: string
/auth/logout:
get:
summary: Logout a user
tags:
- Auth
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
/auth/register:
post:
summary: "Register a new user"
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
username:
type: string
displayName:
type: string
password:
type: string
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
username:
type: string
displayName:
type: string