-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
201 lines (189 loc) · 4.5 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
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
openapi: 3.0.1
info:
title: api.hangulize.org
version: 0.0.0
license:
name: MIT
servers:
- url: https://api.hangulize.org/v2
description: Production server
paths:
/version:
get:
summary: Returns the version of the underlying Hangulize.
responses:
'200':
description: The Hangulize version.
content:
text/plain:
schema:
type: string
example: 0.1.0
application/json:
schema:
type: object
properties:
version:
type: string
example: {
"version": "0.1.0"
}
/specs:
get:
summary: >-
Returns the list of supported language-specific transcription
specifications.
responses:
'200':
description: The spec list.
content:
text/plain:
example: |-
ita
deu
jpn
application/json:
schema:
type: object
properties:
specs:
type: array
items:
$ref: '#/components/schemas/Spec'
/specs/{lang}.hgl:
get:
summary: Serves the HGL source.
parameters:
- $ref: '#/components/parameters/lang'
responses:
'200':
description: The HGL source.
content:
text/vnd.hgl: {}
/hangulized/{lang}/{word}:
get:
summary: Transcribes a non-Korean word into Hangul.
parameters:
- $ref: '#/components/parameters/lang'
- $ref: '#/components/parameters/word'
responses:
'200':
description: A transcription result.
content:
text/plain:
schema:
type: string
example: 글로리아
application/json:
schema:
type: object
properties:
lang:
type: string
word:
type: string
transcribed:
type: string
example: {
"lang": "ita",
"word": "gloria",
"transcribed": "글로리아"
}
/phonemized/{phonemizer}/{word}:
get:
summary: Guesses phonograms.
parameters:
- $ref: '#/components/parameters/phonemizer'
- $ref: '#/components/parameters/word'
responses:
'200':
description: A phonemization result.
content:
text/plain:
schema:
type: string
example: ニホンゴ
application/json:
schema:
type: object
properties:
phonemizer:
type: string
word:
type: string
phonemized:
type: string
example: {
"phonemizer": "furigana",
"word": "日本語",
"phonemized": "ニホンゴ"
}
components:
schemas:
Spec:
type: object
properties:
lang:
$ref: '#/components/schemas/Lang'
config:
$ref: '#/components/schemas/Config'
test:
$ref: '#/components/schemas/Test'
Lang:
type: object
properties:
id:
type: string
codes:
type: array
items:
type: string
english:
type: string
korean:
type: string
script:
type: string
Config:
type: object
properties:
authors:
type: array
items:
type: string
stage:
type: string
Test:
type: array
items:
type: object
properties:
word:
type: string
transcribed:
type: string
parameters:
lang:
name: lang
description: Langauge ID
in: path
required: true
schema:
type: string
example: ita
phonemizer:
name: phonemizer
description: Phonemizer ID
in: path
required: true
schema:
type: string
example: furigana
word:
name: word
description: Non-Korean word
in: path
required: true
schema:
type: string
example: gloria