Skip to content

Commit d1019e3

Browse files
Enhance field descriptions in opensign.yaml
Updated descriptions for several fields to clarify behavior regarding template values and request body overrides.
1 parent 5c39492 commit d1019e3

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/docs/API-docs/v1.1/opensign.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6076,7 +6076,7 @@ components:
60766076
example: true
60776077
timeToCompleteDays:
60786078
type: number
6079-
description: time to complete days is used to calculate expiry date of your document
6079+
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.
60806080
format: number
60816081
example: 15
60826082
enableOTP:
@@ -6110,7 +6110,7 @@ components:
61106110
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.
61116111
61126112
If nothing is set, it will use the owner’s preferences. If the owner’s preferences are also not set, it will default to "".
6113-
6113+
61146114
example: mailer@opensignlabs.com
61156115
allow_modifications:
61166116
type: boolean
@@ -6132,7 +6132,7 @@ components:
61326132
example: false
61336133
remind_once_in_every:
61346134
type: number
6135-
description: "Number of days between reminders. This is only applicable when auto_reminder is set to true."
6135+
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.
61366136
example: 5
61376137
merge_certificate:
61386138
type: boolean
@@ -6168,7 +6168,7 @@ components:
61686168
example: ["user@example.com","user2@example.com"]
61696169
description: |
61706170
bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.
6171-
If this field is present in the request body, it overrides the template value, even when provided as an empty array ([]).
6171+
If this field is present in the request body, it overrides the template value, even when provided as an empty array ([]) or empty string "".
61726172
If omitted, the template value is used.
61736173
prefill:
61746174
type: object

0 commit comments

Comments
 (0)