WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-08-22 23:52:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Enhance field descriptions in opensign.yaml

Browse Source 
Updated descriptions for several fields to clarify behavior regarding template values and request body overrides.
This commit is contained in:
prafull-opensignlabs
2026-03-17 18:25:03 +05:30
committed by GitHub
parent 5c3949239e
commit d1019e3ef6
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/API-docs/v1.1/opensign.yaml
+4 -4
View File
@@ -6076,7 +6076,7 @@ components:
example: true
timeToCompleteDays:
type: number
description: time to complete days is used to calculate expiry date of your document
description: time to complete days is used to calculate expiry date of your document. If this field is present in the request body, it overrides the template value, even when set to 0. If omitted, the template value is used.
format: number
example: 15
enableOTP:
@@ -6110,7 +6110,7 @@ components:
The email address of the person or organization that users can reply to. If this field is present in the request body, it overrides the template value, even when set to an empty string (""). If omitted, the template value is used.
If nothing is set, it will use the owner’s preferences. If the owner’s preferences are also not set, it will default to "".
example: mailer@opensignlabs.com
allow_modifications:
type: boolean
@@ -6132,7 +6132,7 @@ components:
example: false
remind_once_in_every:
type: number
description: "Number of days between reminders. This is only applicable when auto_reminder is set to true."
description: Number of days between reminders. This is only applicable when auto_reminder is set to true. If this field is present in the request body, it overrides the template value, even when set to 0. If omitted, the template value is used.
example: 5
merge_certificate:
type: boolean
@@ -6168,7 +6168,7 @@ components:
example: ["user@example.com","user2@example.com"]
description: |
bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.
If this field is present in the request body, it overrides the template value, even when provided as an empty array ([]).
If this field is present in the request body, it overrides the template value, even when provided as an empty array ([]) or empty string "".
If omitted, the template value is used.
prefill:
type: object