/
docraptor.yaml
461 lines (447 loc) · 13.9 KB
/
docraptor.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
openapi: '3.0.0'
info: # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#info-object
version: "2.0.0"
title: DocRaptor
description: "A native client library for the DocRaptor HTML to PDF/XLS service."
termsOfService: "https://docraptor.com/tos"
license:
name: "MIT"
url: "https://mit-license.org/"
servers:
- url: https://api.docraptor.com
description: DocRaptor API endpoint
paths:
/docs:
post:
operationId: createDoc
tags: [Doc]
description: >
Creates a document synchronously.
security:
- basicAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Doc'
required: true
responses:
200:
description: Successful response
content:
"*/*":
schema:
type: string
format: byte
400:
description: Bad Request
401:
description: Unauthorized
403:
description: Forbidden
422:
description: Unprocessable Entity
500:
description: Server Error
/hosted_docs:
post:
operationId: createHostedDoc
tags: [Doc]
description: >
Creates a hosted document synchronously.
security:
- basicAuth: []
requestBody:
description: The document to be created.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Doc'
responses:
200:
description: Successful response
content:
"*/*":
schema:
$ref: '#/components/schemas/DocStatus'
400:
description: Bad Request
401:
description: Unauthorized
403:
description: Forbidden
422:
description: Unprocessable Entity
500:
description: Server Error
/async_docs:
post:
operationId: createAsyncDoc
tags: [Doc]
description: >
Creates a document asynchronously.
You must use a callback url or the returned status id and the status API to find out when it completes.
Then use the download API to get the document.
security:
- basicAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Doc'
required: true
responses:
200:
description: Successful response
content:
"*/*":
schema:
$ref: '#/components/schemas/AsyncDoc'
400:
description: Bad Request
401:
description: Unauthorized
403:
description: Forbidden
422:
description: Unprocessable Entity
500:
description: Server Error
/hosted_async_docs:
post:
operationId: createHostedAsyncDoc
tags: [Doc]
description: >
Creates a hosted document asynchronously.
You must use a callback url or the returned status id and the status API to find out when it completes.
Then use the download API to get the document.
security:
- basicAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Doc'
required: true
responses:
200:
description: Successful response
content:
"*/*":
schema:
$ref: '#/components/schemas/AsyncDoc'
400:
description: Bad Request
401:
description: Unauthorized
403:
description: Forbidden
422:
description: Unprocessable Entity
500:
description: Server Error
/status/{id}:
get:
operationId: getAsyncDocStatus
tags: [Doc]
description: >
Check on the status of an asynchronously created document.
security:
- basicAuth: []
parameters:
- name: id
in: path
description: The status_id returned when creating an asynchronous document.
required: true
schema:
type: string
responses:
200:
description: Successful response
content:
"*/*":
schema:
$ref: '#/components/schemas/DocStatus'
401:
description: Unauthorized
403:
description: Forbidden
500:
description: Server Error
/download/{id}:
get:
operationId: getAsyncDoc
tags: [Doc]
description: >
Downloads a finished document.
security:
- basicAuth: []
parameters:
- name: id
in: path
description: The download_id returned from an async status request or callback.
required: true
schema:
type: string
responses:
200:
description: Successful response
content:
"*/*":
schema:
type: string
format: byte
400:
description: Bad Request
403:
description: Forbidden
500:
description: Server Error
/expire/{id}:
patch:
operationId: expire
tags: [Doc]
description: >
Expires a previously created hosted doc.
security:
- basicAuth: []
parameters:
- name: id
in: path
description: The download_id returned from status request or hosted document response.
required: true
schema:
type: string
responses:
200:
description: Successful response
401:
description: Unauthorized
403:
description: Forbidden
500:
description: Server Error
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
description: Use your API key as the username. Password does not need to be set.
schemas:
Doc:
type: object
required:
- name
- document_type
properties:
name:
type: string
description: A name for identifying your document.
document_type:
type: string
description: The type of document being created.
enum:
- pdf
- xls
- xlsx
document_content:
type: string
description: >
The HTML data to be transformed into a document.
You must supply content using document_content or document_url.
document_url:
type: string
description: >
The URL to fetch the HTML data to be transformed into a document.
You must supply content using document_content or document_url.
test:
type: boolean
description: Enable test mode for this document. Test documents are not charged for but include a watermark.
default: true
pipeline:
type: string
description: Specify a specific verison of the DocRaptor Pipeline to use.
strict:
type: string
description: Force strict HTML validation.
enum:
- none
- html
ignore_resource_errors:
type: boolean
description: Failed loading of images/javascripts/stylesheets/etc. will not cause the rendering to stop.
default: true
ignore_console_messages:
type: boolean
description: Prevent console.log from stopping document rendering during JavaScript execution.
default: false
tag:
type: string
description: A field for storing a small amount of metadata with this document.
help:
type: boolean
description: Request support help with this request if it succeeds.
default: false
javascript:
type: boolean
description: Enable DocRaptor JavaScript parsing. PrinceXML JavaScript parsing is also available elsewhere.
default: false
referrer:
type: string
description: Set HTTP referrer when generating this document.
callback_url:
type: string
description: >
A URL that will receive a POST request after successfully completing an asynchronous document.
The POST data will include download_url and download_id similar to status API responses.
WARNING: this only works on asynchronous documents.
hosted_download_limit:
type: integer
description: The number of times a hosted document can be downloaded. If no limit is specified, the document will be available for an unlimited number of downloads.
hosted_expires_at:
type: string
description: The date and time at which a hosted document will be removed and no longer available. Must be a properly formatted ISO 8601 datetime, like 1981-01-23T08:02:30-05:00.
user_agent_token:
type: string
description: A token that will be added to the user agent for all requests made for document content while creating a PDF.
prince_options:
$ref: '#/components/schemas/PrinceOptions'
PrinceOptions:
type: object
properties:
baseurl:
type: string
description: Set the baseurl for assets.
no_xinclude:
type: boolean
description: Disable XML inclusion.
no_network:
type: boolean
description: Disable network access.
no_parallel_downloads:
type: boolean
description: Disables parallel fetching of assets during PDF creation. Useful if your asset host has strict rate limiting.
http_user:
type: string
description: Set the user for HTTP authentication.
http_password:
type: string
description: Set the password for HTTP authentication.
http_proxy:
type: string
description: Set the HTTP proxy server.
http_timeout:
type: integer
description: Set the HTTP request timeout.
insecure:
type: boolean
description: Disable SSL verification.
media:
type: string
description: Specify the CSS media type. Defaults to "print" but you may want to use "screen" for web styles.
no_author_style:
type: boolean
description: Ignore author stylesheets.
no_default_style:
type: boolean
description: Ignore default stylesheets.
no_embed_fonts:
type: boolean
description: Disable font embedding in PDFs.
no_subset_fonts:
type: boolean
description: Disable font subsetting in PDFs.
no_compress:
type: boolean
description: Disable PDF compression.
encrypt:
type: boolean
description: Encrypt PDF output.
key_bits:
type: integer
description: Set encryption key size.
enum:
- 40
- 128
user_password:
type: string
description: Set the PDF user password.
owner_password:
type: string
description: Set the PDF owner password.
disallow_print:
type: boolean
description: Disallow printing of this PDF.
disallow_copy:
type: boolean
description: Disallow copying of this PDF.
disallow_annotate:
type: boolean
description: Disallow annotation of this PDF.
disallow_modify:
type: boolean
description: Disallow modification of this PDF.
debug:
type: boolean
description: Enable Prince debug mode.
input:
type: string
description: Specify the input format, defaults to html.
enum:
- html
- xml
- auto
version:
type: string
deprecated: true
description: Deprecated, use the appropriate `pipeline` version. Specify a specific verison of PrinceXML to use.
javascript:
type: boolean
description: Enable PrinceXML JavaScript. DocRaptor JavaScript parsing is also available elsewhere.
css_dpi:
type: integer
description: Set the DPI when rendering CSS. Defaults to 96 but can be set with Prince 9.0 and up.
profile:
type: string
description: In Prince 9.0 and up you can set the PDF profile.
pdf_title:
type: string
description: Specify the PDF title, part of the document's metadata.
iframes:
type: boolean
description: Enable loading of iframes.
nullable: true
page_margin:
type: string
description: Specify the page margin distance.
pdf_forms:
type: boolean
description: Make form fields editable by default.
AsyncDoc:
type: object
properties:
status_id:
type: string
description: The identifier used to get the status of the document using the status API.
DocStatus:
type: object
properties:
status:
type: string
description: The present status of the document. Can be queued, working, completed, and failed.
download_url:
type: string
description: The URL where the document can be retrieved. This URL may only be used a few times.
download_id:
type: string
description: The identifier for downloading the document with the download API.
message:
type: string
description: Additional information.
number_of_pages:
type: integer
description: Number of PDF pages in document.
validation_errors:
type: string
description: Error information.