-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcomedy-club-openapi.yml
194 lines (194 loc) · 4.89 KB
/
comedy-club-openapi.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
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
openapi: 3.0.1
info:
description: "The Comedy Club API."
version: "1.0.0"
title: "Comedy Club API"
servers:
- url: http://localhost:8081/comedy-club/
tags:
- name: "Club"
description: "Club API"
- name: "Address"
description: "Address API"
- name: "Comedian"
description: "Comedian API"
- name: "Event"
description: "Event API"
paths:
/club/{name}:
post:
summary: 'Create Club.'
tags:
- Club
parameters:
- in: path
required: true
name: name
schema:
description: 'Club name'
type: string
example: "Comedians"
responses:
'200':
description: 'Response: Club'
content:
application/json:
schema:
$ref: '#/components/schemas/club'
'404':
description: 'Response: Club was not identified'
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
/club/{id}:
get:
summary: 'Get club by id.'
tags:
- Club
parameters:
- in: path
required: true
name: id
schema:
description: 'Club Id'
type: uuid
example: '412968c0-cbcd-4b54-a16d-54fb6ca465db'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
description: Search results.
items:
$ref: '#/components/schemas/club'
'404':
description: 'Response: Club was not identified'
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
delete:
summary: 'Delete club by id.'
tags:
- Club
parameters:
- in: path
required: true
name: id
schema:
description: 'Club Id'
type: uuid
example: '412968c0-cbcd-4b54-a16d-54fb6ca465db'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
description: Search results.
items:
$ref: '#/components/schemas/club'
'404':
description: 'Response: Club was not identified'
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
/club:
get:
summary: 'Get all clubs.'
tags:
- Club
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
description: Search results.
items:
$ref: '#/components/schemas/club'
'404':
description: 'Response: Club was not identified'
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
put:
summary: 'Update Club.'
tags:
- Club
parameters:
- in: body
required: true
name: club
schema:
type: object
properties:
id:
type: uuid
description: Club Id.
example: '412968c0-cbcd-4b54-a16d-54fb6ca465db'
name:
type: string
description: 'Club Name.'
example: Comedians
createdAt:
type: string
format: date
example: '1984-08-27'
description: 'Creation date.'
responses:
'200':
description: 'Response: Club'
content:
application/json:
schema:
$ref: '#/components/schemas/club'
'404':
description: 'Response: Club was not identified'
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
components:
schemas:
NotFound:
type: object
required:
- code
- message
properties:
code:
type: number
example: 404
message:
type: string
example: Could not find information for the Club identifier entered
club:
title: Club
type: object
description: Comedy Club.
properties:
id:
type: uuid
description: Club Id.
example: '412968c0-cbcd-4b54-a16d-54fb6ca465db'
name:
type: string
description: 'Club Name.'
example: Comedians
createdAt:
type: string
format: date
example: '1984-08-27'
description: 'Creation date.'
required:
- id
- name
- createdAt