Skip to content

Commit e16b526

Browse files
committed
fix(openapi.yml): update host expiration logic and add application/json response type
This commit message summarizes the changes in the provided git diff. It mentions the update to the host expiration logic, where the expiration date can now exceed 7 days with a monthly fee, and the addition of the 'application/json' response type with the required 'url' property.
1 parent f479fd0 commit e16b526

File tree

1 file changed

+33
-3
lines changed

1 file changed

+33
-3
lines changed

openapi.yml

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -300,8 +300,8 @@ paths:
300300
format: date-time
301301
description: >-
302302
If host is enabled, the expiration date of the presigned
303-
URL. Defaults to 7 days from now. Cannot exceed 7 days
304-
from now.
303+
URL. Defaults to 7 days from now. If more than 7 days,
304+
the document will be hosted for a monthly fee.
305305
fileName:
306306
type: string
307307
description: >-
@@ -402,7 +402,27 @@ paths:
402402
properties:
403403
options:
404404
type: object
405-
properties: {}
405+
properties:
406+
host:
407+
type: boolean
408+
description: >-
409+
If enabled, the document will be hosted by FileForge and
410+
a presigned URL will be returned.
411+
default: false
412+
expiresAt:
413+
type: string
414+
format: date-time
415+
description: >-
416+
If host is enabled, the expiration date of the presigned
417+
URL. Defaults to 7 days from now. If more than 7 days,
418+
the document will be hosted for a monthly fee.
419+
fileName:
420+
type: string
421+
description: >-
422+
The name of the generated PDF file. Defaults to
423+
document. The file name should not contain extensions
424+
nor path traversals.
425+
default: document
406426
files:
407427
allOf:
408428
- {}
@@ -428,6 +448,16 @@ paths:
428448
schema:
429449
type: string
430450
format: binary
451+
application/json:
452+
schema:
453+
type: object
454+
required:
455+
- url
456+
properties:
457+
url:
458+
type: string
459+
format: uri
460+
description: URL to the merged PDF document
431461
'400':
432462
description: Bad request
433463
content:

0 commit comments

Comments
 (0)