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

feat: update doc add enableTourvariable

Browse Source
This commit is contained in:
RaktimaNXG
2024-09-30 16:47:08 +05:30
parent 77cf6de722
commit f6245cfada
1 changed files with 35 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/API-docs/opensign.yaml
+35 -6
View File
@@ -1425,7 +1425,12 @@ components:
example: true
enableOTP:
type: boolean
example: false
example: false
description: "true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps."
enableTour:
type: boolean
example: false
description: "true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience."
createdocument_body:
required:
- file
@@ -1477,9 +1482,13 @@ components:
type: boolean
example: true
enableOTP:
type: boolean
example: false
description: "true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps."
enableTour:
type: boolean
example: false
inline_response_200_d:
description: "true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience."
type: object
properties:
objectId:
@@ -1552,7 +1561,12 @@ components:
example: 15
enableOTP:
type: boolean
example: false
example: false
description: "true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps."
enableTour:
type: boolean
example: false
description: "true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience."
resendmail_body:
required:
- document_id
@@ -1616,7 +1630,12 @@ components:
example: ""
enableOTP:
type: boolean
example: false
example: false
description: "true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps."
enableTour:
type: boolean
example: false
description: "true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience."
inline_response_200_3:
type: object
properties:
@@ -1685,7 +1704,12 @@ components:
example: true
enableOTP:
type: boolean
example: false
example: false
description: "true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps."
enableTour:
type: boolean
example: false
description: "true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience."
inline_response_200_5:
type: object
properties:
@@ -1721,7 +1745,12 @@ components:
example: ""
enableOTP:
type: boolean
example: false
example: false
description: "true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps."
enableTour:
type: boolean
example: false
description: "true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience."
inline_response_404_7:
type: object
properties: