chore: deprecate endpoints (#3022)

This commit is contained in:
David Nguyen
2026-07-23 13:57:09 +10:00
committed by GitHub
parent 7f85388eb7
commit 26f0c4c5b7
37 changed files with 451 additions and 43 deletions
+34 -10
View File
@@ -51,8 +51,9 @@ export const fieldRouter = router({
path: '/document/field/{fieldId}',
summary: 'Get document field',
description:
'Returns a single field. If you want to retrieve all the fields for a document, use the "Get Document" endpoint.',
'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Returns a single field. If you want to retrieve all the fields for a document, use the "Get Document" endpoint.',
tags: ['Document Fields'],
deprecated: true,
},
})
.input(ZGetFieldRequestSchema)
@@ -84,8 +85,10 @@ export const fieldRouter = router({
method: 'POST',
path: '/document/field/create',
summary: 'Create document field',
description: 'Create a single field for a document.',
description:
'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Create a single field for a document.',
tags: ['Document Fields'],
deprecated: true,
},
})
.input(ZCreateDocumentFieldRequestSchema)
@@ -130,8 +133,10 @@ export const fieldRouter = router({
method: 'POST',
path: '/document/field/create-many',
summary: 'Create document fields',
description: 'Create multiple fields for a document.',
description:
'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Create multiple fields for a document.',
tags: ['Document Fields'],
deprecated: true,
},
})
.input(ZCreateDocumentFieldsRequestSchema)
@@ -172,8 +177,10 @@ export const fieldRouter = router({
method: 'POST',
path: '/document/field/update',
summary: 'Update document field',
description: 'Update a single field for a document.',
description:
'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Update a single field for a document.',
tags: ['Document Fields'],
deprecated: true,
},
})
.input(ZUpdateDocumentFieldRequestSchema)
@@ -212,8 +219,10 @@ export const fieldRouter = router({
method: 'POST',
path: '/document/field/update-many',
summary: 'Update document fields',
description: 'Update multiple fields for a document.',
description:
'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Update multiple fields for a document.',
tags: ['Document Fields'],
deprecated: true,
},
})
.input(ZUpdateDocumentFieldsRequestSchema)
@@ -250,7 +259,10 @@ export const fieldRouter = router({
method: 'POST',
path: '/document/field/delete',
summary: 'Delete document field',
description:
'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.',
tags: ['Document Fields'],
deprecated: true,
},
})
.input(ZDeleteDocumentFieldRequestSchema)
@@ -323,8 +335,10 @@ export const fieldRouter = router({
method: 'POST',
path: '/template/field/create',
summary: 'Create template field',
description: 'Create a single field for a template.',
description:
'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Create a single field for a template.',
tags: ['Template Fields'],
deprecated: true,
},
})
.input(ZCreateTemplateFieldRequestSchema)
@@ -370,8 +384,9 @@ export const fieldRouter = router({
path: '/template/field/{fieldId}',
summary: 'Get template field',
description:
'Returns a single field. If you want to retrieve all the fields for a template, use the "Get Template" endpoint.',
'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Returns a single field. If you want to retrieve all the fields for a template, use the "Get Template" endpoint.',
tags: ['Template Fields'],
deprecated: true,
},
})
.input(ZGetFieldRequestSchema)
@@ -403,8 +418,10 @@ export const fieldRouter = router({
method: 'POST',
path: '/template/field/create-many',
summary: 'Create template fields',
description: 'Create multiple fields for a template.',
description:
'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Create multiple fields for a template.',
tags: ['Template Fields'],
deprecated: true,
},
})
.input(ZCreateTemplateFieldsRequestSchema)
@@ -445,8 +462,10 @@ export const fieldRouter = router({
method: 'POST',
path: '/template/field/update',
summary: 'Update template field',
description: 'Update a single field for a template.',
description:
'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Update a single field for a template.',
tags: ['Template Fields'],
deprecated: true,
},
})
.input(ZUpdateTemplateFieldRequestSchema)
@@ -485,8 +504,10 @@ export const fieldRouter = router({
method: 'POST',
path: '/template/field/update-many',
summary: 'Update template fields',
description: 'Update multiple fields for a template.',
description:
'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Update multiple fields for a template.',
tags: ['Template Fields'],
deprecated: true,
},
})
.input(ZUpdateTemplateFieldsRequestSchema)
@@ -523,7 +544,10 @@ export const fieldRouter = router({
method: 'POST',
path: '/template/field/delete',
summary: 'Delete template field',
description:
'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.',
tags: ['Template Fields'],
deprecated: true,
},
})
.input(ZDeleteTemplateFieldRequestSchema)