-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathapi-definition.yml
304 lines (292 loc) · 7.18 KB
/
api-definition.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
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
296
297
298
299
300
301
302
303
304
openapi: 3.0.0
info:
description: Api documentation for news pipeline
version: 1.0.0
title: News Pipeline
servers:
- url: http://news.f4.htw-berlin.de:8081/api
- url: http://localhost:8080
tags:
- name: "articles"
description: "Retrieve news articles"
- name: "analytics"
description: "View analytics for news articles"
paths:
/articles:
get:
tags:
- "articles"
summary: "Get news articles"
description: ""
operationId: "getArticles"
parameters:
- in: query
name: offset
schema:
type: integer
default: 0
required: false
description: Numeric ID of the user to get
- in: query
name: count
schema:
type: integer
default: 20
required: false
description: Number of articles to return
- in: query
name: query
schema:
type: string
required: false
description: Search query to filter articles
- in: query
name: department
schema:
type: array
items:
type: string
required: false
description: Department to filter articles
- in: query
name: newspaper
schema:
type: array
items:
type: string
required: false
description: Newspaper to filter articles
- in: query
name: author
schema:
type: string
required: false
description: Author to filter articles
responses:
200:
description: "successful operation"
content:
application/json:
schema:
type: "array"
items:
$ref: "#/components/schemas/Article"
405:
description: "Invalid input"
/articles/{articleId}:
get:
tags:
- "articles"
summary: "Find article by id"
description: "Only single ID can be provided"
operationId: "findArticlesByStatus"
parameters:
- in: path
name: "articleId"
schema:
type: "integer"
required: true
description: "ID of article to return"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: "#/components/schemas/Article"
400:
description: "Invalid ID supplied"
404:
description: "Article not found"
/articles/departments:
get:
tags:
- "articles"
summary: "Get departments"
operationId: "getDepartments"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
type: "array"
items:
type: string
405:
description: "Invalid input"
/articles/newspapers:
get:
tags:
- "articles"
summary: "Get newspapers"
operationId: "getNewspapers"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
type: "array"
items:
type: string
405:
description: "Invalid input"
/articles/authors:
get:
tags:
- "articles"
summary: "Get authors"
description: "Get authors filtered by query. If no query is given return the top 20 authors"
operationId: "getAuthors"
parameters:
- in: query
name: query
schema:
type: string
required: false
description: Query to filter authors
responses:
200:
description: "successful operation"
content:
application/json:
schema:
type: "array"
items:
type: string
405:
description: "Invalid input"
/analytics/terms:
get:
tags:
- "analytics"
summary: "Get term occurrences per day"
operationId: "getTermOccurrences"
parameters:
- in: query
name: query
schema:
type: string
required: true
description: Term to get occurrences for
- in: query
name: timeFrom
schema:
type: integer
required: false
description: Start date to look for occurrences in milliseconds
- in: query
name: timeTo
schema:
type: integer
required: false
description: End date to look for occurrences in milliseconds
responses:
200:
description: "successful operation"
content:
application/json:
schema:
type: "array"
items:
$ref: "#/components/schemas/TermOccurrences"
404:
description: "Term not found in articles"
405:
description: "Invalid input"
/analytics/lemmas:
get:
tags:
- "analytics"
summary: "Get most relevant lemmas for the last 7 days"
operationId: "getMostRelevantLemmas"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
type: "array"
items:
$ref: "#/components/schemas/Lemma"
404:
description: "No articles found for last week"
components:
schemas:
Article:
type: "object"
properties:
id:
type: "string"
site:
type: "string"
title:
type: "string"
description:
type: "string"
intro:
type: "string"
text:
type: "string"
url:
type: "string"
TermOccurrence:
type: "object"
properties:
date:
type: "integer"
dateString:
type: "string"
occurrences:
type: "integer"
TermOccurrences:
type: "object"
properties:
totalResult:
type: "integer"
query:
type: "string"
timeFrom:
type: "integer"
timeTo:
type: "integer"
occurrences:
type: "array"
items:
$ref: "#/components/schemas/TermOccurrence"
Lemma:
type: "object"
properties:
lemma:
type: "string"
docCount:
type: "integer"
Filter:
type: "object"
properties:
offset:
type: "integer"
count:
type: "integer"
query:
type: "string"
department:
type: "string"
date:
type: "string"
format: "date-time"
newspaper:
type: "string"
author:
type: "string"
ApiResponse:
type: "object"
properties:
code:
type: "integer"
format: "int32"
type:
type: "string"
message:
type: "string"