/
openapi.yaml
172 lines (170 loc) · 3.94 KB
/
openapi.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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
openapi: 3.0.3
info:
version: 1.0.0
title: Twitter API
tags:
- name: Twitter
description: Twitter Clone API
paths:
/users:
post:
summary: Create a user
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/User'
responses:
'201':
description: User created successfully
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
get:
summary: List all users
responses:
'200':
description: List of users
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/users/{id}:
get:
summary: Get user profile by ID
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: User ID
responses:
'200':
description: User profile
content:
application/json:
schema:
$ref: '#/components/schemas/User'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/tweets:
post:
summary: Create a tweet
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Tweet'
responses:
'201':
description: Tweet created successfully
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
get:
summary: List all tweets
responses:
'200':
description: List of tweets
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Tweet'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/tweets/{id}:
get:
summary: Get tweet by ID
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Tweet ID
responses:
'200':
description: Tweet details
content:
application/json:
schema:
$ref: '#/components/schemas/Tweet'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
User:
type: object
properties:
id:
type: string
format: uuid
username:
type: string
email:
type: string
format: email
name:
type: string
required:
- username
- email
Tweet:
type: object
properties:
id:
type: string
format: uuid
content:
type: string
user_id:
type: string
format: uuid
required:
- content
- user_id
Error:
required:
- code
- message
properties:
code:
type: integer
format: int32
description: Error code
message:
type: string
description: Error message