Skip to content

Commit

Permalink
chore(openapi): update OpenAPI schema descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@fern-api
fern-api[bot] committed Sep 7, 2024
1 parent 1d00d4d commit f433293
Showing 1 changed file with 100 additions and 94 deletions.
194 changes: 100 additions & 94 deletions openapi.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ components:
example: BAD_REQUEST
message:
type: string
description:
description: >-
A human-readable message. This field may also provide additional
context to the error code.
example: Bad request
Expand Down Expand Up @@ -133,16 +133,18 @@ paths:
properties:
keepOriginalStyles:
type: boolean
description:
Whether to keep the text formatting of the variables in the
document. Default is true.
description: >-
Whether to keep the text formatting of the variables in
the document. Default is true.
templateLiterals:
type: object
description: Map of template literals to replace in the document.
additionalProperties:
type: string
file:
description: The Microsoft Word document (.DOCX or .DOC) file to convert to PDF.
description: >-
The Microsoft Word document (.DOCX or .DOC) file to convert
to PDF.
type: string
format: binary
encoding:
Expand Down Expand Up @@ -200,36 +202,37 @@ paths:
properties:
test:
type: boolean
description:
Generate a test document instead of a production document. The
generated document will contain a watermark. Defaults to
true.
description: >-
Generate a test document instead of a production
document. The generated document will contain a
watermark. Defaults to true.
default: true
host:
type: boolean
description:
If enabled, the document will be hosted by FileForge and a
presigned URL will be returned.
description: >-
If enabled, the document will be hosted by FileForge and
a presigned URL will be returned.
default: false
expiresAt:
type: string
format: date-time
description:
If host is enabled, the expiration date of the presigned URL.
Defaults to 7 days from now. If more than 7 days, the
document will be hosted for a monthly fee.
description: >-
If host is enabled, the expiration date of the presigned
URL. Defaults to 7 days from now. If more than 7 days,
the document will be hosted for a monthly fee.
fileName:
type: string
description:
The name of the generated PDF file. Defaults to document. The file
name should not contain extensions nor path traversals.
description: >-
The name of the generated PDF file. Defaults to
document. The file name should not contain extensions
nor path traversals.
default: document
allowViewing:
type: boolean
description:
If enabled, the document will be viewable in the web app. Defaults
to false. This may go against the privacy policy of your
application.
description: >-
If enabled, the document will be viewable in the web
app. Defaults to false. This may go against the privacy
policy of your application.
default: false
files:
description: >-
Expand Down Expand Up @@ -306,7 +309,7 @@ paths:
application/json:
schema:
description: Bad Gateway
$ref: "#/components/schemas/def-0"
$ref: '#/components/schemas/def-0'
/pdf/merge/:
post:
operationId: mergePDFDocuments
Expand All @@ -327,29 +330,30 @@ paths:
properties:
host:
type: boolean
description:
If enabled, the document will be hosted by FileForge and a
presigned URL will be returned.
description: >-
If enabled, the document will be hosted by FileForge and
a presigned URL will be returned.
default: false
expiresAt:
type: string
format: date-time
description:
If host is enabled, the expiration date of the presigned URL.
Defaults to 7 days from now. If more than 7 days, the
document will be hosted for a monthly fee.
description: >-
If host is enabled, the expiration date of the presigned
URL. Defaults to 7 days from now. If more than 7 days,
the document will be hosted for a monthly fee.
fileName:
type: string
description:
The name of the generated PDF file. Defaults to document. The file
name should not contain extensions nor path traversals.
description: >-
The name of the generated PDF file. Defaults to
document. The file name should not contain extensions
nor path traversals.
default: document
allowViewing:
type: boolean
description:
If enabled, the document will be viewable in the web app. Defaults
to false. This may go against the privacy policy of your
application.
description: >-
If enabled, the document will be viewable in the web
app. Defaults to false. This may go against the privacy
policy of your application.
default: false
files:
allOf:
Expand Down Expand Up @@ -386,7 +390,7 @@ paths:
type: string
format: uri
description: URL to the merged PDF document
"400":
'400':
description: Bad request
content:
application/json:
Expand All @@ -409,9 +413,9 @@ paths:
tags:
- PDF
- form
description:
Returns a list of form fields detected in the PDF document, along
with their location, options and requirements. For a more visual
description: >-
Returns a list of form fields detected in the PDF document, along with
their location, options and requirements. For a more visual
representation, use the /pdf/form/mark endpoint.
requestBody:
content:
Expand Down Expand Up @@ -480,15 +484,15 @@ paths:
properties:
x:
type: number
y:
'y':
type: number
width:
type: number
height:
type: number
required:
- x
- y
- 'y'
- width
- height
required:
Expand Down Expand Up @@ -604,9 +608,9 @@ paths:
tags:
- PDF
- form
description:
Returns a modified PDF document with form fields marked with a
green border, and hover text showing the field name.
description: >-
Returns a modified PDF document with form fields marked with a green
border, and hover text showing the field name.
requestBody:
content:
multipart/form-data:
Expand Down Expand Up @@ -663,9 +667,9 @@ paths:
tags:
- PDF
- form
description:
Returns a modified PDF document with filled form fields. A subset
of fields can be filled.
description: >-
Returns a modified PDF document with filled form fields. A subset of
fields can be filled.
requestBody:
content:
multipart/form-data:
Expand All @@ -681,9 +685,9 @@ paths:
properties:
flattenForm:
type: boolean
description:
Flatten the form fields after filling them. This will make the PDF
form uneditable.
description: >-
Flatten the form fields after filling them. This will
make the PDF form uneditable.
default: false
fields:
type: array
Expand All @@ -698,12 +702,12 @@ paths:
- value
properties:
name:
description:
Name of the field to fill. This must match an exact name from the
PDF document. To detect all fields, use the
/pdf/form/fields endpoint, or use the
/pdf/form/mark endpoint to get an annotated
PDF with each detected field.
description: >-
Name of the field to fill. This must match an
exact name from the PDF document. To detect
all fields, use the /pdf/form/fields endpoint,
or use the /pdf/form/mark endpoint to get an
annotated PDF with each detected field.
type: string
type:
type: string
Expand All @@ -718,12 +722,12 @@ paths:
- checked
properties:
name:
description:
Name of the field to fill. This must match an exact name from the
PDF document. To detect all fields, use the
/pdf/form/fields endpoint, or use the
/pdf/form/mark endpoint to get an annotated
PDF with each detected field.
description: >-
Name of the field to fill. This must match an
exact name from the PDF document. To detect
all fields, use the /pdf/form/fields endpoint,
or use the /pdf/form/mark endpoint to get an
annotated PDF with each detected field.
type: string
type:
type: string
Expand All @@ -738,12 +742,12 @@ paths:
- selected
properties:
name:
description:
Name of the field to fill. This must match an exact name from the
PDF document. To detect all fields, use the
/pdf/form/fields endpoint, or use the
/pdf/form/mark endpoint to get an annotated
PDF with each detected field.
description: >-
Name of the field to fill. This must match an
exact name from the PDF document. To detect
all fields, use the /pdf/form/fields endpoint,
or use the /pdf/form/mark endpoint to get an
annotated PDF with each detected field.
type: string
type:
type: string
Expand All @@ -761,12 +765,12 @@ paths:
- selected
properties:
name:
description:
Name of the field to fill. This must match an exact name from the
PDF document. To detect all fields, use the
/pdf/form/fields endpoint, or use the
/pdf/form/mark endpoint to get an annotated
PDF with each detected field.
description: >-
Name of the field to fill. This must match an
exact name from the PDF document. To detect
all fields, use the /pdf/form/fields endpoint,
or use the /pdf/form/mark endpoint to get an
annotated PDF with each detected field.
type: string
type:
type: string
Expand Down Expand Up @@ -818,7 +822,7 @@ paths:
summary: Splits a PDF document into 2 PDF documents.
tags:
- PDF
description:
description: >-
Splits a PDF document into 2 PDF documents. Returns a zip file
containing the 2 documents. Each document is named after the original
document with a suffix added to indicate the range of pages it contains.
Expand All @@ -839,9 +843,9 @@ paths:
splitPage:
type: integer
minimum: 1
description:
The page number to split the document at (the page will be included
in the first document)
description: >-
The page number to split the document at (the page will
be included in the first document)
file:
type: string
format: binary
Expand Down Expand Up @@ -885,11 +889,11 @@ paths:
summary: Extract a range of pages from a PDF document.
tags:
- PDF
description:
Extracts a range of pages from a PDF document. The start and end
pages are included in the extracted document. The extracted document is
named after the original document with a suffix added to indicate the
range of pages it contains (ex:document\_extracted\_\$start\_\$end.pdf).
description: >-
Extracts a range of pages from a PDF document. The start and end pages
are included in the extracted document. The extracted document is named
after the original document with a suffix added to indicate the range of
pages it contains (ex:document\_extracted\_\$start\_\$end.pdf).
requestBody:
content:
multipart/form-data:
Expand Down Expand Up @@ -956,13 +960,13 @@ paths:
summary: Insert a PDF document into another PDF document at a specified page.
tags:
- PDF
description:
"Insert a PDF document into another PDF document at a specified
page. The inserted document is named after the original document with a
suffix added to indicate the range of pages it contains
(ex:document\\_inserted\\_\\$insertPage\\_\\$document2.pdf). Note: The
first document is the parent document and the second document is the
document to be inserted."
description: >-
Insert a PDF document into another PDF document at a specified page. The
inserted document is named after the original document with a suffix
added to indicate the range of pages it contains
(ex:document\_inserted\_\$insertPage\_\$document2.pdf). Note: The first
document is the parent document and the second document is the document
to be inserted.
requestBody:
content:
multipart/form-data:
Expand Down Expand Up @@ -1028,7 +1032,7 @@ paths:
description: Get the status of the API
x-fern-availability: generally-available
responses:
"200":
'200':
description: Default Response
content:
application/json:
Expand All @@ -1040,6 +1044,8 @@ paths:
servers:
- url: https://api.fileforge.com
description: Global Server
- url: https://us-west-1.api.fileforge.com
description: Regional Server
tags:
- name: PDF
description: PDF operations
Expand Down

0 comments on commit f433293

Please sign in to comment.