Ryan/documenso
1
0
Fork 1
mirror of https://github.com/documenso/documenso.git synced 2026-07-20 15:06:14 +10:00
Code Issues Packages Projects Releases Wiki Activity

chore: add v1 API deprecation callouts and clean up imports

Browse Source 
Add deprecation warning callouts to public API documentation pages.
Remove unused imports from webhook router and hooks.
This commit is contained in:
ephraimduncan
2026-01-20 15:28:37 +00:00
parent fd94a403af
commit 1bc090cb83
7 changed files with 25 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/documentation/pages/developers/public-api/index.mdx
+4
View File
@@ -31,6 +31,10 @@ Our new API V2 supports the following typed SDKs:
## API V1 - Deprecated
<Callout type="warning">
v1 API is deprecated and will be removed in a future release. Please migrate to v2.
</Callout>
Check out the [API V1 documentation](https://app.documenso.com/api/v1/openapi) for details about the API endpoints, request parameters, response formats, and authentication methods.
📖 [Documentation](https://documen.so/api-v2-docs)
apps/documentation/pages/developers/public-api/versioning.mdx
+2
View File
@@ -11,6 +11,8 @@ Documenso uses API versioning to manage changes to the public API. This allows u
<Callout type="info">The current version of the API is `v2`.</Callout>
<Callout type="warning">v1 API is deprecated. Please migrate to v2.</Callout>
The API version is specified in the URL. For example, the base URL for the `v2` API is `https://app.documenso.com/api/v2`.
We may make changes to the API without incrementing the version number. We will always try to avoid breaking changes, but in some cases, it may be necessary to make changes that are not backward compatible. In these cases, we will increment the version number and provide information about the changes in the release notes.