From f6245cfada5d67697fa7a2ea9aa9c93058707d04 Mon Sep 17 00:00:00 2001 From: RaktimaNXG Date: Mon, 30 Sep 2024 16:47:08 +0530 Subject: [PATCH 1/2] feat: update doc add enableTourvariable --- docs/docs/API-docs/opensign.yaml | 41 +++++++++++++++++++++++++++----- 1 file changed, 35 insertions(+), 6 deletions(-) diff --git a/docs/docs/API-docs/opensign.yaml b/docs/docs/API-docs/opensign.yaml index 0a278c362..f34948e1b 100644 --- a/docs/docs/API-docs/opensign.yaml +++ b/docs/docs/API-docs/opensign.yaml @@ -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: From d9f8ea8aca36ff92a4463719186a2db4246f026f Mon Sep 17 00:00:00 2001 From: RaktimaNXG Date: Mon, 7 Oct 2024 10:23:28 +0530 Subject: [PATCH 2/2] refactor code --- docs/docs/API-docs/opensign.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/docs/API-docs/opensign.yaml b/docs/docs/API-docs/opensign.yaml index f34948e1b..b38b704d1 100644 --- a/docs/docs/API-docs/opensign.yaml +++ b/docs/docs/API-docs/opensign.yaml @@ -1489,6 +1489,7 @@ components: 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_d: type: object properties: objectId: