-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi.yml
342 lines (333 loc) · 9.14 KB
/
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
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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
openapi: 3.0.0
info:
title: "Divvun Grammar Checker Server API"
version: "0.2.0"
contact:
name: Brendan Molloy
email: brendan@technocreatives.com
servers:
- url: https://api-giellalt.uit.no
description: Staging server
tags:
- name: General
- name: Grammar check
- name: Spellcheck
- name: Hyphenation
paths:
/speller/{languageCode}:
parameters:
- name: languageCode
in: path
required: true
example: se
description: The specified language
schema:
type: string
post:
operationId: postSpellCheck
tags:
- Spellcheck
summary: Returns spelling check results
description: Returns spelling check results for the supplied text and language
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/SpellCheckRequest"
responses:
'200':
description: List of spelling check results
content:
application/json:
schema:
$ref: "#/components/schemas/SpellerResponse"
default:
description: Error
/grammar/{languageCode}:
parameters:
- name: languageCode
in: path
required: true
example: se
description: The specified language
schema:
type: string
post:
operationId: postGrammarCheck
tags:
- Grammar check
summary: Returns grammar check results
description: Returns grammar check results for the supplied text and language
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/GrammarCheckRequest"
responses:
'200':
description: List of grammar check results
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/GramcheckResponse"
default:
description: Error
/hyphenation/{languageCode}:
parameters:
- name: languageCode
in: path
required: true
example: se
description: The specified language
schema:
type: string
post:
operationId: postHyphenate
tags:
- Hyphenation
summary: Returns hyphenations for each word in the text
description: Returns hyphenation results for the supplied text and language
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/HyphenationRequest"
responses:
'200':
description: List of hyphenation results
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/HyphenationResult"
default:
description: Error
/preferences/grammar/{languageCode}:
parameters:
- name: languageCode
in: path
required: true
example: se
description: The specified language
schema:
type: string
get:
operationId: getGrammarPreferences
tags:
- Grammar check
- General
summary: Returns grammar checker preferences
description: Returns available grammar checker preferences for the specified language code
responses:
'200':
description: A set of preferences
content:
application/json:
schema:
$ref: "#/components/schemas/GramcheckPreferencesResponse"
default:
description: Error
/languages:
get:
operationId: getLanguageOptions
tags:
- General
summary: Returns options related to languages
description: Returns options related to languages, like what languages are available
responses:
'200':
description: A set of options
content:
application/json:
schema:
$ref: "#/components/schemas/AvailableLanguagesResponse"
default:
description: Error
components:
schemas:
SpellCheckRequest:
type: object
required:
- text
properties:
word:
type: string
GrammarCheckRequest:
type: object
required:
- text
properties:
text:
type: string
HyphenationRequest:
type: object
required:
- text
properties:
word:
type: string
GrammarError:
type: object
required:
- error_text
- start_index
- end_index
- error_code
- description
- suggestions
properties:
error_text:
type: string
example: "servodat dilálašvuođain"
description: The part of the text which is incorrect
start_index:
type: integer
example: 167
description: The starting index of the error_text within the submitted text
end_index:
type: integer
example: 190
description: The ending index of the error_text within the submitted text
error_code:
type: string
example: "msyn-compound"
description: The identifier of the error
description:
type: string
example: servodat dilálašvuođain berrešii leat oktan sátnin.
description: The human readable description of what the error is
suggestions:
type: array
description: A list of suggestions for replacing the error_text
items:
type: string
example: servodatdilálašvuođain
GramcheckResponse:
type: object
required:
- text
- errs
properties:
text:
type: string
description: The text to which the errors relate to
example: Bealljeheamit leat, nu movt Norgga Bealljehemiidlihttu oaidná, duvdojuvvon olggobeallai diehtojuohkinservodaga, miidagaha ahte bealljeheamit dávjá ožžot unnit dieđuid servodat dilálašvuođain.
errs:
type: array
items:
$ref: "#/components/schemas/GrammarError"
SpellerResult:
type: object
required:
- word
- isCorrect
- suggestions
properties:
word:
type: string
description: the supplied word
example: oainá
isCorrect:
type: boolean
description: Whether the word is spelled correctly
example: false
suggestions:
type: object
required:
- value
- weight
properties:
value:
type: string
description: Potential correction
example: oaidná
weight:
type: number
description: Weight of the correction
example: 18.432617
SpellerResponse:
type: object
required:
- text
- results
properties:
text:
type: string
description: The supplied text, one or more words
example: oainá páhkat
results:
type: array
items:
$ref: "#/components/schemas/SpellerResult"
GramcheckPreferencesResponse:
type: object
properties:
error_tags:
type: object
additionalProperties:
type: string
example: { "tag": "description" }
HyphenationResult:
type: object
required:
- word
- hyphenations
properties:
word:
type: string
description: the supplied word
example: ođasmahtinministtar
hyphenations:
type: array
items:
type: object
required:
- value
- weight
properties:
value:
type: string
description: Hyphenation pattern
example: o^đas^maht^tin#mi^nist^tar
weight:
type: string
description: Weight of the suggestion
example: 60.000000
HyphenationResponse:
type: object
required:
- text
- results
properties:
text:
type: string
description: The supplied text, one or more words
example: ođasmahttinministtar ođasmahtinministtar
results:
type: array
items:
$ref: "#/components/schemas/HyphenationResult"
AvailableLanguagesResponse:
type: object
properties:
available:
type: object
properties:
grammar:
type: object
additionalProperties:
type: string
example: { "se": "davvisámegiella", "bg": "български" }
speller:
type: object
additionalProperties:
type: string
example: { "se": "davvisámegiella" }
hyphenation:
type: object
additionalProperties:
type: string
example: { "se": "davvisámegiella" }