Skip to content

Commit 25ecf72

Browse files
update create document and create document from template response
1 parent bb18fea commit 25ecf72

File tree

1 file changed

+29
-3
lines changed

1 file changed

+29
-3
lines changed

docs/docs/API-docs/opensign.yaml

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ paths:
331331
content:
332332
application/json:
333333
schema:
334-
$ref: '#/components/schemas/inline_response_200_1'
334+
$ref: '#/components/schemas/inline_response_doc'
335335
"400":
336336
description: "Something went wrong, please try again later!"
337337
content:
@@ -373,11 +373,11 @@ paths:
373373
required: true
374374
responses:
375375
"200":
376-
description: "In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"
376+
description: Document created successfully!
377377
content:
378378
application/json:
379379
schema:
380-
$ref: '#/components/schemas/inline_response_200_2'
380+
$ref: '#/components/schemas/inline_response_doc'
381381
"400":
382382
description: If you haven't add widgets and signers in template or not provide signers along with their roles in body
383383
content:
@@ -1774,6 +1774,21 @@ components:
17741774
type: string
17751775
format: string
17761776
example: https://url-to-sign-document.com
1777+
inline_response_doc:
1778+
type: object
1779+
properties:
1780+
objectId:
1781+
type: string
1782+
format: string
1783+
example: hji2zxcv2P
1784+
signurl:
1785+
type: array
1786+
items:
1787+
$ref: '#/components/schemas/inline_response_doc_signurl'
1788+
message:
1789+
type: string
1790+
format: string
1791+
example: Document sent successfully!
17771792
inline_draft_doc_res_200_1:
17781793
type: object
17791794
properties:
@@ -2384,6 +2399,17 @@ components:
23842399
type: array
23852400
items:
23862401
$ref: '#/components/schemas/createdocument_body_widgets'
2402+
inline_response_doc_signurl:
2403+
type: object
2404+
properties:
2405+
email:
2406+
type: string
2407+
format: string
2408+
example: mail@example.com
2409+
url:
2410+
type: string
2411+
format: string
2412+
example: https://url-to-sign-document.com
23872413
securitySchemes:
23882414
x-api-token:
23892415
type: apiKey

0 commit comments

Comments
 (0)