🌿 ✨ [Scheduled] Update API Spec #8
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds three new endpoints to the API related to PDF form field detection, marking, and filling. The new endpoints are `/pdf/form/detect/`, `/pdf/form/mark/`, and `/pdf/form/fill/`. Each endpoint is described with a summary, tags, and a description of its functionality. The request and response schemas are also defined for each endpoint, including the required parameters and the expected responses for success and error cases.
This commit message summarizes the changes in the git diff, which includes updating the title and description of the API, as well as adding and modifying metadata for various operations. The changes are primarily related to fixing and improving the API documentation and operation details.
This commit removes the `x-fern-examples` section from multiple paths in the OpenAPI specification and updates the description of the `host` parameter in the `/pdf/generate/` path to correctly capitalize "FileForge".
This commit removes the `x-fern-examples` sections from the `openapi.yml` file, which contain code samples for various SDK languages.
This commit removes the `x-fern-examples` section from the `openapi.yml` file, which includes code samples for various SDKs such as curl and TypeScript.
…ples This commit message strictly adheres to the Conventional Commits specification, with the type being 'fix' and the description summarizing the changes made in the git diff. The response status codes have been changed from numbers to strings, and the examples for making API requests have been removed.
This commit adds a new option `flattenForm` to the fields properties in the openapi.yml file. The `flattenForm` option is a boolean that, when enabled, will flatten the form fields after filling them, making the PDF form uneditable.
…on 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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
The API changelog includes various description updates, the addition of a basic authentication scheme, and a new regional server URL.
Added
https://us-west-1.api.fileforge.com.Changed
Removed