-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
499 lines (498 loc) · 14.1 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
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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
openapi: 3.0.3
info:
title: Citation.js Toolforge - OpenAPI 3.0
description: >-
Export citations from Wikidata items and generate QuickStatements for
publications not yet
on Wikidata.
license:
name: MIT
url: https://opensource.org/license/mit/
version: 0.0.0
externalDocs:
description: Find out more about Citation.js
url: https://citation.js.org/
servers:
- url: https://citation-js.toolforge.org/api/v1
tags:
- name: Export
description: Export bibliographical data for Wikidata entities
- name: QuickStatements
description: Generate QuickStatements from bibliographical data
externalDocs:
description: Find out more about QuickStatements
url: https://quickstatements.toolforge.org/#/
paths:
/export/{entityId}/biblatex:
get:
tags:
- Export
summary: Export a Wikidata entity to BibLaTeX
operationId: exportEntityBiblatex
parameters:
- name: entityId
in: path
description: Wikidata Entity ID
required: true
schema:
type: string
example: Q30000000
responses:
'200':
description: Successful operation
content:
application/x-bibtex: {}
'406':
description: Input not valid
'415':
description: Requested output format unknown
/export/{entityId}/bibliography:
get:
tags:
- Export
summary: Export a Wikidata entity to a reference list
operationId: exportEntityBibliography
parameters:
- name: entityId
in: path
description: Wikidata Entity ID
required: true
schema:
type: string
example: Q30000000
- name: template
in: query
description: CSL style
required: false
schema:
$ref: '#/components/schemas/CslStyle'
example: vancouver
- name: lang
in: query
description: CSL locale
required: false
schema:
$ref: '#/components/schemas/CslLocale'
example: fr-FR
- name: format
in: query
description: Citeproc-js format
schema:
$ref: '#/components/schemas/CslFormat'
required: false
example: html
- name: asEntryArray
in: query
description: Return array of reference list entries
required: false
schema:
type: boolean
default: false
- name: nosort
in: query
description: Keep the reference list in order of input
required: false
schema:
type: boolean
default: false
- name: prepend
in: query
description: Prepend string to each reference
required: false
schema:
type: string
- name: append
in: query
description: Append string to each reference
required: false
schema:
type: string
responses:
'200':
description: Successful operation
content:
text/html: {}
text/plain: {}
text/rtf: {}
application/x-latex: {}
application/json: {}
'406':
description: Input not valid
'415':
description: Requested output format unknown
/export/{entityId}/bibtex:
get:
tags:
- Export
summary: Export a Wikidata entity to BibTeX
operationId: exportEntityBibtex
parameters:
- name: entityId
in: path
description: Wikidata Entity ID
required: true
schema:
type: string
example: Q30000000
responses:
'200':
description: Successful operation
content:
application/x-bibtex: {}
'406':
description: Input not valid
'415':
description: Requested output format unknown
/export/{entityId}/bibtxt:
get:
tags:
- Export
summary: Export a Wikidata entity to Bib.TXT
operationId: exportEntityBibtxt
parameters:
- name: entityId
in: path
description: Wikidata Entity ID
required: true
schema:
type: string
example: Q30000000
responses:
'200':
description: Successful operation
content:
text/plain: {}
'406':
description: Input not valid
'415':
description: Requested output format unknown
/export/{entityId}/citation:
get:
tags:
- Export
summary: Export a Wikidata entity to an in-text citation
operationId: exportEntityCitation
parameters:
- name: entityId
in: path
description: Wikidata Entity ID
required: true
schema:
type: string
example: Q30000000
- name: template
in: query
description: CSL style
required: false
schema:
$ref: '#/components/schemas/CslStyle'
example: vancouver
- name: lang
in: query
description: CSL locale
required: false
schema:
$ref: '#/components/schemas/CslLocale'
example: fr-FR
- name: format
in: query
description: Citeproc-js format
schema:
$ref: '#/components/schemas/CslFormat'
required: false
example: html
responses:
'200':
description: Successful operation
content:
text/html: {}
text/plain: {}
text/rtf: {}
application/x-latex: {}
application/json: {}
'406':
description: Input not valid
'415':
description: Requested output format unknown
/export/{entityId}/csljson:
get:
tags:
- Export
summary: Export a Wikidata entity to CSL-JSON
operationId: exportEntityCslJson
parameters:
- name: entityId
in: path
description: Wikidata Entity ID
required: true
schema:
type: string
example: Q30000000
- name: version
in: query
description: CSL-JSON version
schema:
type: string
default: 1.0.2
responses:
'200':
description: Successful operation
content:
application/vnd.citationstyles.csl+json: {}
'406':
description: Input not valid
'415':
description: Requested output format unknown
/export/{entityId}/cslndjson:
get:
tags:
- Export
summary: Export a Wikidata entity to CDL-NDJSON
operationId: exportEntityCslNdjson
parameters:
- name: entityId
in: path
description: Wikidata Entity ID
required: true
schema:
type: string
example: Q30000000
- name: version
in: query
description: CSL-JSON version
schema:
type: string
default: 1.0.2
responses:
'200':
description: Successful operation
content:
application/x-ndjson: {}
'406':
description: Input not valid
'415':
description: Requested output format unknown
/export/{entityId}/ris:
get:
tags:
- Export
summary: Export a Wikidata entity to RIS
operationId: exportEntityRis
parameters:
- name: entityId
in: path
description: Wikidata Entity ID
required: true
schema:
type: string
example: Q30000000
- name: spec
in: query
description: RIS specification
required: false
schema:
type: string
default: mixed
enum:
- mixed
- new
- old
responses:
'200':
description: Successful operation
content:
application/x-research-info-systems: {}
'406':
description: Input not valid
'415':
description: Requested output format unknown
# QuickStatements
/quickstatements:
post:
tags:
- QuickStatements
summary: Generate QuickStatements from BibTeX/RIS input
operationId: quickstatements
requestBody:
required: true
content:
application/x-bibtex:
schema:
type: string
title: BibTeX or BibLaTeX
example: |-
@article{Miccadei2002Synergistic,
author = {Miccadei, Stefania and De Leo, Rossana and Zammarchi, Enrico and Natali, Pier Giorgio and Civitareale, Donato},
journaltitle = {Molecular Endocrinology},
doi = {10.1210/MEND.16.4.0808},
issn = {0888-8809},
number = {4},
date = {2002-04-01},
keywords = {transcription},
language = {en},
pages = {837--846},
eprint = {11923479},
eprinttype = {pubmed},
title = {The {Synergistic} {Activity} of {Thyroid} {Transcription} {Factor} 1 and {Pax} 8 {Relies} on the {Promoter}/{Enhancer} {Interplay}},
volume = {16},
}
application/vnd.citationstyles.csl+json:
schema:
type: string
title: CSL-JSON
example: |-
[
{
"id": "Q30000000",
"custom": {
"QID": "Q30000000"
},
"source": "Wikidata",
"author": [
{
"given": "Stefania",
"family": "Miccadei",
"_ordinal": 1
},
{
"given": "Rossana",
"family": "De Leo",
"_ordinal": 2
},
{
"given": "Enrico",
"family": "Zammarchi",
"_ordinal": 3
},
{
"given": "Pier Giorgio",
"family": "Natali",
"_ordinal": 4
},
{
"given": "Donato",
"family": "Civitareale",
"_ordinal": 5
}
],
"container-title": "Molecular Endocrinology",
"DOI": "10.1210/MEND.16.4.0808",
"ISSN": "0888-8809",
"issue": "4",
"issued": {
"date-parts": [
[
2002,
4,
1
]
]
},
"keyword": "transcription",
"language": "en",
"page": "837-846",
"PMID": "11923479",
"title": "The Synergistic Activity of Thyroid Transcription Factor 1 and Pax 8 Relies on the Promoter/Enhancer Interplay",
"type": "article-journal",
"volume": "16"
}
]
application/x-research-info-systems:
schema:
type: string
title: RIS
example: |-
TY - JOUR
AU - Miccadei, Stefania
AU - De Leo, Rossana
AU - Zammarchi, Enrico
AU - Natali, Pier Giorgio
AU - Civitareale, Donato
DA - 2002/4/1/
DB - Wikidata
DO - 10.1210/MEND.16.4.0808
ID - Q30000000
IS - 4
KW - transcription
LA - en
SN - 0888-8809
SP - 837-846
T2 - Molecular Endocrinology
TI - The Synergistic Activity of Thyroid Transcription Factor 1 and Pax 8 R
elies on the Promoter/Enhancer Interplay
VL - 16
ER -
application/x-cff:
schema:
type: string
title: Citation File Format (YAML)
responses:
'200':
description: Successful operation
content:
text/plain: {}
'406':
description: Input not valid
/quickstatements/doi/{doi}:
get:
tags:
- QuickStatements
summary: Generate QuickStatements from a DOI
operationId: quickstatementsDoi
parameters:
- name: doi
in: path
description: Digital Object Identifier (DOI), escaped
required: true
schema:
type: string
example: '10.5281/zenodo.8242099'
responses:
'200':
description: Successful operation
content:
text/plain: {}
'406':
description: Input not valid
/quickstatements/isbn/{isbn}:
get:
tags:
- QuickStatements
summary: Generate QuickStatements from an ISBN
operationId: quickstatementsIsbn
parameters:
- name: isbn
in: path
description: ISBN
required: true
schema:
type: string
example: '978-3-030-67727-5'
responses:
'200':
description: Successful operation
content:
text/plain: {}
'406':
description: Input not valid
components:
schemas:
CslStyle:
type: string
default: apa
externalDocs:
description: CSL citation styles
url: https://github.com/citation-style-language/styles
CslLocale:
type: string
default: en-US
externalDocs:
description: CSL locale files
url: https://github.com/citation-style-language/locales
CslFormat:
type: string
enum:
- html
- text
- rtf
- latex