-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.v1.yaml
295 lines (295 loc) · 7.09 KB
/
api.v1.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
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
openapi: 3.0.0
info:
title: Metacomposite
version: '1.0'
description: Returns posts from multiple feeds
servers:
- url: 'http://localhost:3000'
paths:
'/feeds/{feedID}':
parameters:
- schema:
type: string
name: feedID
in: path
required: true
get:
summary: Your GET endpoint
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Feed'
operationId: get-feeds-feedID
description: Get a feed by ID
'/feeds/{feedID}/posts':
parameters:
- schema:
type: string
name: feedID
in: path
required: true
get:
summary: Your GET endpoint
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
feed:
$ref: '#/components/schemas/Feed'
posts:
type: array
items:
$ref: '#/components/schemas/Post'
operationId: get-feeds-feedID-posts
description: Get posts associated with the feed
'/groups/{groupID}':
parameters:
- schema:
type: string
name: groupID
in: path
required: true
get:
summary: Your GET endpoint
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
operationId: get-group-groupID
description: Get a group by ID
'/groups/{groupID}/posts':
parameters:
- schema:
type: string
name: groupID
in: path
required: true
get:
summary: Your GET endpoint
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
group:
$ref: '#/components/schemas/Group'
posts:
type: array
items:
$ref: '#/components/schemas/Post'
errors:
type: array
items:
$ref: '#/components/schemas/Error'
operationId: get-group-groupID-posts
description: Get posts associated with a group
'/groups/{groupID}/feeds':
parameters:
- schema:
type: string
name: groupID
in: path
required: true
get:
summary: Your GET endpoint
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
group:
$ref: '#/components/schemas/Group'
feeds:
type: array
items:
$ref: '#/components/schemas/Feed'
operationId: get-groups-groupID-feeds
description: Get feeds associated with a group
/groups:
get:
summary: Your GET endpoint
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Group'
operationId: get-groups
description: Get all groups
/feeds:
get:
summary: Your GET endpoint
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Feed'
operationId: get-feeds
description: Get all feeds
/feeds/posts:
get:
summary: Your GET endpoint
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
posts:
type: array
items:
$ref: '#/components/schemas/Post'
errors:
type: array
items:
$ref: '#/components/schemas/Error'
examples: {}
operationId: get-feeds-posts
description: Get all posts from all feeds
'/redditgallery/{galleryID}':
parameters:
- schema:
type: string
name: galleryID
in: path
required: true
description: ID of the Reddit Gallery
get:
summary: Your GET endpoint
tags: []
responses:
'200':
description: OK
content:
text/html:
schema:
type: object
properties: {}
operationId: get-redditgallery-galleryID
description: Proxies a reddit gallery for iFraming in Metacomposite
components:
schemas:
Post:
title: Post
type: object
properties:
ID:
type: string
title:
type: string
description:
type: string
content:
type: string
link:
type: string
permalink:
type: string
imageURLs:
type: array
items:
type: string
feedID:
type: string
timestamp:
type: integer
isRedditGallery:
type: boolean
required:
- ID
- title
- description
- content
- link
- permalink
- imageURLs
- feedID
- timestamp
- isRedditGallery
Feed:
title: Feed
type: object
properties:
ID:
type: string
name:
type: string
groupID:
type: array
items:
type: string
description:
type: string
URI:
type: string
type:
type: string
required:
- ID
- name
- groupID
- description
- URI
- type
Group:
title: Group
type: object
properties:
ID:
type: string
name:
type: string
required:
- ID
- name
Error:
title: Error
type: object
properties:
code:
type: string
message:
type: string
relatedIDs:
type: array
items:
type: string
required:
- code
- message
- relatedIDs