From 32c5a0a77affb8bd7061d15b795ede6e4881c1ea Mon Sep 17 00:00:00 2001 From: prafull-opensignlabs <93375423+prafull-opensignlabs@users.noreply.github.com> Date: Mon, 29 Jan 2024 15:16:37 +0530 Subject: [PATCH] Update opensign.yaml --- docs/docs/API-docs/opensign.yaml | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/docs/docs/API-docs/opensign.yaml b/docs/docs/API-docs/opensign.yaml index 89a9ac022..ca67feb47 100644 --- a/docs/docs/API-docs/opensign.yaml +++ b/docs/docs/API-docs/opensign.yaml @@ -299,11 +299,17 @@ paths: required: true responses: "200": - description: Document created successfully! + description: "In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage" content: application/json: schema: $ref: '#/components/schemas/inline_response_200_2' + "400": + description: If you haven't add widgets and signers in template or not provide signers along with their roles in body + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_400_1' "405": description: Invalid API Token! content: @@ -1067,17 +1073,17 @@ components: createdocumenttemplate_id_Signers: type: object properties: - Role: + role: type: string example: Accoutnant - Email: + email: type: string format: mail example: joe@example.com - Name: + name: type: string example: joe bee - Phone: + phone: type: string example: "123123131" createdocument_template_id_body: @@ -1098,6 +1104,10 @@ components: type: string format: string example: https://example.com + message: + type: string + format: string + example: Document sent successfully! inline_response_404_3: type: object properties: @@ -1282,6 +1292,13 @@ components: Name: type: string example: joe + inline_response_400_1: + type: object + properties: + error: + type: string + format: string + example: Please setup template properly! createdocument_body_signers: type: object properties: