-
Notifications
You must be signed in to change notification settings - Fork 0
/
calibre.yaml
473 lines (473 loc) · 12.5 KB
/
calibre.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
swagger: "2.0"
info:
description: "This is the (undocumented) calibre content server http API."
version: "1.0.0"
title: "Calibre Content Server"
license:
name: "GPL3"
url: "https://www.gnu.org/licenses/gpl-3.0.en.html"
host: "your.calibre.instance"
basePath: "/"
tags:
- name: "content"
description: "Content"
- name: "code"
description: "Code"
- name: "legacy"
description: "Legacy"
- name: "convert"
description: "Convert"
- name: "ajax"
description: "Ajax"
- name: "users_api"
description: "Users API"
- name: "opds"
description: "OPDS"
- name: "cdb"
description: "Calibre DB"
- name: "books"
description: "Books"
schemes:
- "https"
- "http"
paths:
/get/{what}/{book_id}/{library_id}:
get:
tags:
- "content"
summary: "Fetch object"
description: "This endpoint is a generic \"Fetch propery `what` from this `book_id`\" endpoint. It can be used to fetch metadata, thumbnail/cover images, opf information, or the book itself.\nvalid `what` values are \"thumb\", \"cover\", \"opf\", \"json\", or a book format (such as \"EPUB\")."
operationId: "getBook"
produces:
- "application/oebps-package+xml"
- "application/json"
- "image/jpg"
- "application/epub+zip"
parameters:
- name: "what"
in: "path"
description: "What kind of thing should be returned"
required: true
type: "string"
- name: "book_id"
in: "path"
description: "What book has this thing"
required: true
type: "integer"
- name: "library_id"
in: "path"
description: "What library is this thing in"
required: false
type: "string"
default: ""
responses:
"200":
description: "successful operation"
"403":
description: "user is not allowed to access library, or library does not exist"
"404":
description: "book_id not found"
/cdb/add-book/{job_id}/{add_duplicates}/{filename}/{library_id}:
post:
tags:
- "cdb"
summary: "Add a file as a new book. The file contents must be in the body of the request."
description: "The response will also have the title/authors/languages read from the\nmetadata of the file/filename. It will contain a `book_id` field specifying\nthe id of the newly added book, or if add_duplicates is not specified and a\nduplicate was found, no book_id will be present, instead there will be a\n`duplicates` field specifying the title and authors for all duplicate\nmatches. It will also return the value of `job_id` as the `id` field and\n`filename` as the `filename` field."
operationId: "addBook"
produces:
- "application/json"
parameters:
- name: "job_id"
in: "path"
description: "An id to give the job"
required: true
type: "integer"
- name: "add_duplicates"
in: "path"
description: "Does this contain duplicates"
required: true
type: "string"
enum:
- "n"
- "y"
- name: "filename"
in: "path"
description: "What is the filename for the book"
required: true
type: "string"
- name: "library_id"
in: "path"
description: "What library to add the book to"
required: false
default: ""
type: "string"
- name: "book"
in: "formData"
description: "The book file contents"
required: true
type: "file"
responses:
"200":
description: "book added"
schema:
$ref: "#/definitions/BookAdded"
/cdb/delete-books/{book_ids}/{library_id}:
post:
tags:
- "cdb"
summary: "Delete book_ids from library"
operationId: "deleteBooks"
parameters:
- name: "book_ids"
in: "path"
description: "comma separated list of books"
required: true
type: "string"
- name: "library_id"
in: "path"
description: "What library to are the books in"
required: false
default: ""
type: "string"
responses:
"200":
description: "books deleted"
"404":
description: "book_id not found"
/ajax/book/{book_id}/{library_id}:
get:
tags:
- "ajax"
summary: "Return the metadata of the book as a JSON dictionary."
operationId: "metadataBook"
produces:
- "application/json"
parameters:
- name: "book_id"
in: "path"
description: "Book id of book to fetch metadata of"
required: true
type: "integer"
- name: "library_id"
in: "path"
description: "What library is the book in?"
required: false
default: ""
type: "integer"
- name: "category_urls"
in: "query"
description: "Also include a mapping of category (field) names to URLs that return the list of books in the given category"
required: false
default: true
type: "boolean"
- name: "id_is_uuid"
in: "query"
description: "If id_is_uuid is true then the book_id is assumed to be a book uuid instead"
required: false
default: false
type: "boolean"
- name: "device_for_template"
in: "query"
description: "TODO: I don't know what this parameter does"
required: false
type: "string"
responses:
"200":
description: "Metadata!"
"404":
description: "book_id not found"
/ajax/books_in/{encoded_category}/{encoded_item}/{library_id}:
get:
tags:
- "ajax"
summary: "Return the books (as list of ids) present in the specified category."
operationId: "booksIn"
produces:
- "application/json"
parameters:
- name: "encoded_category"
in: "path"
description: "Category"
required: true
type: "integer"
- name: "encoded_item"
in: "path"
description: "Item"
required: true
type: "integer"
- name: "library_id"
in: "path"
description: "Library the category/item are in"
required: false
default: ""
type: "string"
- name: "num"
in: "query"
description: "How many book ids to return"
required: false
default: 100
type: "integer"
- name: "offset"
in: "query"
description: "Offset from book_id 0"
required: false
default: 0
type: "integer"
- name: "sort"
in: "query"
description: "What field should the ids be sorted by"
required: false
default: "title"
type: "string"
- name: "sort_order"
in: "query"
description: "Ascending or descending sort?"
required: false
default: "asc"
type: "string"
enum:
- "asc"
- "desc"
- name: "get_additional_fields"
in: "query"
description: "TODO: I don't know what this parameter does"
required: false
type: "string"
responses:
"200":
description: "Books!"
schema:
$ref: "#/definitions/BookIn"
"404":
description: "book_id not found"
/ajax/search/{library_id}:
get:
tags:
- "ajax"
summary: "Return the books matching the specified search query."
description: "Return the books matching the specified search query.\nThe returned object is a dict with the field book_ids which\nis a list of matched book ids."
operationId: "searchLibrary"
produces:
- "application/json"
parameters:
- name: "library_id"
in: "path"
description: "What library are you searching in"
required: false
type: "string"
- name: "query"
in: "query"
description: "Search query"
required: true
type: "string"
- name: "num"
in: "query"
description: "Number of results to return"
required: false
default: 100
type: "integer"
- name: "offset"
in: "query"
description: "Offset from results 0"
required: false
default: 0
type: "integer"
- name: "sort"
in: "query"
description: "What field should the ids be sorted by"
required: false
default: "title"
type: "string"
- name: "sort_order"
in: "query"
description: "Ascending or descending sort?"
required: false
default: "asc"
type: "string"
enum:
- "asc"
- "desc"
- name: "vl"
in: "query"
description: "TODO: I don't know what this param does"
required: false
type: "string"
responses:
"200":
description: "search results returned"
schema:
$ref: "#/definitions/BookSearch"
"404":
description: "book_id not found"
/cdb/set-fields/{book_id}/{library_id}:
post:
tags:
- "cdb"
summary: "Set fields of a book"
description: "TODO: Can this set fields on multiple books at once even though it's an endpoint with a book id?"
operationId: "setBookFields"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- name: "book_id"
in: "path"
description: "What book to convert"
required: true
type: "integer"
- name: "library_id"
in: "path"
description: "What library is the book in"
required: false
type: "string"
- name: "fields"
in: "body"
description: "What are the changes?"
required: false
type: "object"
schema:
$ref: "#/definitions/FieldChanges"
responses:
"200":
description: "Fields set"
"404":
description: "book_id not found"
/cdb/cmd/{which}/{version}:
post:
tags:
- "cdb"
summary: "Run a calibredb cli command"
operationId: "dbCmd"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- name: "which"
in: "path"
description: "What command to run"
required: true
type: "string"
- name: "version"
in: "path"
description: "What version that command must be"
required: false
default: 0
type: "integer"
- name: "args"
in: "body"
description: "Options to send to the command"
required: true
type: "object"
responses:
"200":
description: "calibredb command run"
"404":
description: "command not found"
securityDefinitions:
basicAuth:
type: basic
security:
- basicAuth: []
definitions:
BookAdded:
type: "object"
required:
- "title"
- "authors"
- "languages"
- "filename"
- "id"
- "book_id"
properties:
id:
type: "integer"
authors:
type: "array"
items:
type: "string"
languages:
type: "array"
items:
type: "string"
filename:
type: "string"
book_id:
type: "integer"
BookIn:
type: "object"
required:
- "total_num"
- "sort_order"
- "offset"
- "num"
- "sort"
- "base_url"
- "book_ids"
properties:
total_num:
type: "integer"
sort_order:
type: "string"
enum:
- "asc"
- "desc"
offset:
type: "integer"
num:
type: "integer"
sort:
type: "string"
base_url:
type: "string"
book_ids:
type: "array"
items:
type: "integer"
BookSearch:
type: "object"
required:
- "total_num"
- "number_books_without_search"
- "offset"
- "base_url"
- "query"
- "library_id"
- "book_ids"
- "vl"
properties:
total_num:
type: "integer"
number_books_without_search:
type: "integer"
offset:
type: "integer"
num:
type: "integer"
base_url:
type: "string"
query:
type: "string"
library_id:
type: "string"
book_ids:
type: "array"
items:
type: "integer"
vl:
type: "string"
FieldChanges:
type: "object"
required:
- "changes"
- "loaded_book_ids"
properties:
changes:
type: "object"
loaded_book_ids:
type: "array"
items:
type: "integer"
all_dirtied:
type: "boolean"