-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi-3.0.yml
241 lines (238 loc) · 6.21 KB
/
openapi-3.0.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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
openapi: '3.0.2'
info:
title: Cruddur Backend API
version: '1.0'
servers:
- url: https://api.server.test/v1
paths:
/api/activities/home:
get:
description: 'Return a feed of activity based on all users'
tags:
- activities
responses:
'200':
description: Returns an array of activities"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Activity'
/api/activities/search:
get:
description: 'Return a feed of activity based on a search term'
tags:
- activities
parameters:
- name: term
in: query
description: Search term used for full text search
required: true
schema:
type: string
example: "#100DaysOfCloud"
responses:
'200':
description: Returns an array of activities"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Activity'
/api/activities:
post:
description: Create a new activitiy eg. Creating a Crud
tags:
- activities
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
handle:
type: string
message:
type: string
ttl:
type: string
responses:
'200':
description: Returns a recently created activity"
content:
application/json:
schema:
type: object
items:
$ref: '#/components/schemas/Activity'
/api/activities/@{handle}:
get:
description: 'Return a feed of activity for a specific user'
tags:
- activities
parameters:
- name: handle
in: path
description: Handle (aka Username)
required: true
schema:
type: string
responses:
'200':
description: Returns an array of activities"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Activity'
/api/message_groups:
get:
description: 'Return a list of two way private conversations for the user'
tags:
- messages
responses:
'200':
description: Returns an array of messages groups for a specific user
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MessageGroup'
/api/messages/@{handle}:
get:
description: 'Returns private communication between two users'
tags:
- messages
parameters:
- name: handle
in: path
description: Handle (aka Username)
required: true
schema:
type: string
responses:
'200':
description: Returns an array of messages between two users
content:
application/json:
schema:
type: object
items:
$ref: '#/components/schemas/Message'
/api/messages:
post:
description: 'Create a direct message between two users'
tags:
- messages
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
user_receiver_handle:
type: string
responses:
'200':
description: Return a single message
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Message'
components:
schemas:
Activity:
type: object
properties:
uuid:
type: string
example: 0056a369-4618-43a4-ad88-e7c371bf5582
display_name:
type: string
example: "Andrew Brown"
handle:
type: string
example: "andrewbrown"
message:
type: string
example: "Who likes pineapple on their pizza?"
replies_count:
type: integer
example: 5
reposts_count:
type: integer
example: 2
likes_count:
type: integer
example: 103
created_at:
type: string
example: "2023-02-06T18:11:03+00:00"
expires_at:
type: string
example: "2023-02-06T18:11:03+00:00"
Reply:
type: object
properties:
uuid:
type: string
example: 0056a369-4618-43a4-ad88-e7c371bf5582
reply_to_activity_uuid:
type: string
example: 0056a369-4618-43a4-ad88-e7c371bf5582
handle:
type: string
example: "andrewbrown"
message:
type: string
example: "Who likes pineapple on their pizza?"
replies_count:
type: integer
example: 5
reposts_count:
type: integer
example: 2
likes_count:
type: integer
example: 103
created_at:
type: string
example: "2023-02-06T18:11:03+00:00"
Message:
type: object
properties:
uuid:
type: string
example: 0056a369-4618-43a4-ad88-e7c371bf5582
display_name:
type: string
example: "Andrew Brown"
handle:
type: string
example: "andrewbrown"
message:
type: string
example: "Who likes pineapple on their pizza?"
created_at:
type: string
example: "2023-02-06T18:11:03+00:00"
MessageGroup:
type: object
properties:
uuid:
type: string
example: 0056a369-4618-43a4-ad88-e7c371bf5582
display_name:
type: string
example: "Worf"
handle:
type: string
example: "worf"