-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
135 lines (135 loc) · 3.18 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
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
openapi: "3.0.1"
info:
version: 1.0.0
title: Swagger Bank API
license:
name: MIT
paths:
/accounts:
get:
summary: List all accounts
operationId: getAllAccounts
tags:
- account
parameters:
- name: limit
in: query
description: How many items to return at one time (max 100)
required: false
schema:
type: integer
format: int32
responses:
'200':
description: A paged array of accounts
content:
application/json:
schema:
$ref: "#/components/schemas/Account"
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
post:
summary: Create an account
operationId: createAccount
tags:
- account
responses:
'201':
description: Empty response
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/accounts/{account_id}:
get:
summary: Fetch an account by id
operationId: getAccountByID
tags:
- account
parameters:
- name: account_id
in: path
required: true
description: The id of the account
schema:
type: string
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: "#/components/schemas/Account"
'404':
description: Not found error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
delete:
summary: Delete an account by id
operationId: deleteAccountByID
tags:
- account
parameters:
- name: account_id
in: path
required: true
description: The id of the account
schema:
type: string
responses:
'200':
description: Empty response
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
components:
schemas:
Account:
type: object
required:
- email
properties:
id:
type: integer
format: int64
email:
type: string
first_name:
type: string
last_name:
type: string
date_of_birth:
type: string
format: date
Accounts:
type: array
items:
$ref: "#/components/schemas/Account"
Error:
type: object
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string