Ryan/documenso
1
0
Fork 1
mirror of https://github.com/documenso/documenso.git synced 2025-11-13 00:03:33 +10:00
Code Issues Packages Projects Releases Wiki Activity

chore: update docs

Browse Source
This commit is contained in:
David Nguyen
2024-11-15 21:47:22 +07:00
parent 979e3f3e71
commit f15f9ecdd1
2 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
packages/api/v1/contract.ts
View File

@ -168,6 +168,9 @@ export const ApiContractV1 = c.router(
500: ZUnsuccessfulResponseSchema, 500: ZUnsuccessfulResponseSchema,
}, },
summary: 'Send a document for signing', summary: 'Send a document for signing',
// I'm aware this should be in the variable itself, which it is, however it's difficult for users to find in our current UI.
description:
'Notes\n\n`sendEmail` - Whether to send an email to the recipients asking them to action the document. If you disable this, you will need to manually distribute the document to the recipients using the generated signing links. Defaults to true',
}, },
resendDocument: { resendDocument: {

5
packages/api/v1/schema.ts
View File

@ -67,7 +67,10 @@ export type TSuccessfulDocumentResponseSchema = z.infer<typeof ZSuccessfulDocume
export const ZSendDocumentForSigningMutationSchema = z export const ZSendDocumentForSigningMutationSchema = z
.object({ .object({
sendEmail: z.boolean().optional().default(true), sendEmail: z.boolean().optional().default(true).openapi({
description:
'Whether to send an email to the recipients asking them to action the document. If you disable this, you will need to manually distribute the document to the recipients using the generated signing links.',
}),
}) })
.or(z.literal('').transform(() => ({ sendEmail: true }))); .or(z.literal('').transform(() => ({ sendEmail: true })));