-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
77 lines (77 loc) · 2.08 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
openapi: 3.0.3
info:
title: FinanceAPP
description: FinanceAPP
version: 2022-04-01
servers:
- url: 'http://localhost:9090/v1'
description: 'Local'
paths:
/signup:
summary: Signup for users to get account
description: User account signup
post:
summary: A POST request to sign up for an account
security: []
operationId: signUp
tags:
- Signup
description: sign up post
requestBody:
description: signup request object
required: true
content:
application/json:
schema:
type: object
properties:
name:
description: full user name
type: string
example: john doe
email:
type: string
description: valid email
example: [email protected]
password:
type: string
description: strong password
example: secureP@ssword
minLength: 6
maxLength: 16
confirm_password:
type: string
example: secureP@ssword
minLength: 6
maxLength: 16
required:
- name
- password
- email
- confirm_password
responses:
'200':
description: succesfully signed up
content:
application/json:
schema:
properties:
name:
type: string
example: Joe doe
email:
type: string
example: [email protected]
default:
description: error
content:
application/json:
schema:
properties:
message:
type: string
error:
type: string
tags:
- name: Signup
description: signup description