Skip to content

Commit 9893840

Browse files
jtreminio-dropboxjtreminio-dropbox
authored
Add edit&resend to OpenAPI docs (#490)
1 parent c8b39cb commit 9893840

File tree

18 files changed

+612
-130
lines changed

18 files changed

+612
-130
lines changed

‎openapi-raw.yaml

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3428,7 +3428,7 @@ paths:
34283428
$ref: '#/components/schemas/SignatureRequestGetResponse'
34293429
examples:
34303430
example:
3431-
$ref: '#/components/examples/SignatureRequestEditResponse'
3431+
$ref: '#/components/examples/SignatureRequestSendResponse'
34323432
4XX:
34333433
description: failed_operation
34343434
content:
@@ -3499,8 +3499,6 @@ paths:
34993499
seo:
35003500
title: '_t__SignatureRequestEdit::SEO::TITLE'
35013501
description: '_t__SignatureRequestEdit::SEO::DESCRIPTION'
3502-
x-hideOn: doc
3503-
x-beta: closed
35043502
'/signature_request/edit_embedded/{signature_request_id}':
35053503
put:
35063504
tags:
@@ -3547,7 +3545,7 @@ paths:
35473545
$ref: '#/components/schemas/SignatureRequestGetResponse'
35483546
examples:
35493547
example:
3550-
$ref: '#/components/examples/SignatureRequestEditEmbeddedResponse'
3548+
$ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse'
35513549
4XX:
35523550
description: failed_operation
35533551
content:
@@ -3617,8 +3615,6 @@ paths:
36173615
seo:
36183616
title: '_t__SignatureRequestEditEmbedded::SEO::TITLE'
36193617
description: '_t__SignatureRequestEditEmbedded::SEO::DESCRIPTION'
3620-
x-hideOn: doc
3621-
x-beta: closed
36223618
'/signature_request/edit_embedded_with_template/{signature_request_id}':
36233619
put:
36243620
tags:
@@ -3663,7 +3659,7 @@ paths:
36633659
$ref: '#/components/schemas/SignatureRequestGetResponse'
36643660
examples:
36653661
example:
3666-
$ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateResponse'
3662+
$ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse'
36673663
4XX:
36683664
description: failed_operation
36693665
content:
@@ -3733,8 +3729,6 @@ paths:
37333729
seo:
37343730
title: '_t__SignatureRequestEditEmbeddedWithTemplate::SEO::TITLE'
37353731
description: '_t__SignatureRequestEditEmbeddedWithTemplate::SEO::DESCRIPTION'
3736-
x-hideOn: doc
3737-
x-beta: closed
37383732
'/signature_request/edit_with_template/{signature_request_id}':
37393733
put:
37403734
tags:
@@ -3779,7 +3773,7 @@ paths:
37793773
$ref: '#/components/schemas/SignatureRequestGetResponse'
37803774
examples:
37813775
example:
3782-
$ref: '#/components/examples/SignatureRequestEditWithTemplateResponse'
3776+
$ref: '#/components/examples/SignatureRequestSendWithTemplateResponse'
37833777
4XX:
37843778
description: failed_operation
37853779
content:
@@ -3850,8 +3844,6 @@ paths:
38503844
seo:
38513845
title: '_t__SignatureRequestEditWithTemplate::SEO::TITLE'
38523846
description: '_t__SignatureRequestEditWithTemplate::SEO::DESCRIPTION'
3853-
x-hideOn: doc
3854-
x-beta: closed
38553847
'/signature_request/files/{signature_request_id}':
38563848
get:
38573849
tags:

‎openapi-sdk.yaml

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3414,7 +3414,7 @@ paths:
34143414
description: |-
34153415
Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
34163416

3417-
**NOTE:** Edit and resend will not deduct your signature request quota.
3417+
**NOTE:** Edit and resend *will* deduct your signature request quota.
34183418
operationId: signatureRequestEdit
34193419
parameters:
34203420
-
@@ -3455,7 +3455,7 @@ paths:
34553455
$ref: '#/components/schemas/SignatureRequestGetResponse'
34563456
examples:
34573457
example:
3458-
$ref: '#/components/examples/SignatureRequestEditResponse'
3458+
$ref: '#/components/examples/SignatureRequestSendResponse'
34593459
'4XX':
34603460
description: failed_operation
34613461
content:
@@ -3526,14 +3526,15 @@ paths:
35263526
seo:
35273527
title: 'Edit Signature Request | REST API | Dropbox Sign for Developers'
35283528
description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest with the submitted documents, click here.'
3529-
x-hideOn: doc
3530-
x-beta: closed
35313529
'/signature_request/edit_embedded/{signature_request_id}':
35323530
put:
35333531
tags:
35343532
- 'Signature Request'
35353533
summary: 'Edit Embedded Signature Request'
3536-
description: 'Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.'
3534+
description: |-
3535+
Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
3536+
3537+
**NOTE:** Edit and resend *will* deduct your signature request quota.
35373538
operationId: signatureRequestEditEmbedded
35383539
parameters:
35393540
-
@@ -3574,7 +3575,7 @@ paths:
35743575
$ref: '#/components/schemas/SignatureRequestGetResponse'
35753576
examples:
35763577
example:
3577-
$ref: '#/components/examples/SignatureRequestEditEmbeddedResponse'
3578+
$ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse'
35783579
'4XX':
35793580
description: failed_operation
35803581
content:
@@ -3644,14 +3645,15 @@ paths:
36443645
seo:
36453646
title: 'Edit Embedded Signature Request | Dropbox Sign for Developers'
36463647
description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to edit a SignatureRequest in an iFrame, click here.'
3647-
x-hideOn: doc
3648-
x-beta: closed
36493648
'/signature_request/edit_embedded_with_template/{signature_request_id}':
36503649
put:
36513650
tags:
36523651
- 'Signature Request'
36533652
summary: 'Edit Embedded Signature Request with Template'
3654-
description: 'Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.'
3653+
description: |-
3654+
Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
3655+
3656+
**NOTE:** Edit and resend *will* deduct your signature request quota.
36553657
operationId: signatureRequestEditEmbeddedWithTemplate
36563658
parameters:
36573659
-
@@ -3690,7 +3692,7 @@ paths:
36903692
$ref: '#/components/schemas/SignatureRequestGetResponse'
36913693
examples:
36923694
example:
3693-
$ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateResponse'
3695+
$ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse'
36943696
'4XX':
36953697
description: failed_operation
36963698
content:
@@ -3760,8 +3762,6 @@ paths:
37603762
seo:
37613763
title: 'Signature Request with Template | Dropbox Sign for Developers'
37623764
description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based on the given Template, click here.'
3763-
x-hideOn: doc
3764-
x-beta: closed
37653765
'/signature_request/edit_with_template/{signature_request_id}':
37663766
put:
37673767
tags:
@@ -3770,7 +3770,7 @@ paths:
37703770
description: |-
37713771
Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter.
37723772

3773-
**NOTE:** Edit and resend will not deduct your signature request quota.
3773+
**NOTE:** Edit and resend *will* deduct your signature request quota.
37743774
operationId: signatureRequestEditWithTemplate
37753775
parameters:
37763776
-
@@ -3809,7 +3809,7 @@ paths:
38093809
$ref: '#/components/schemas/SignatureRequestGetResponse'
38103810
examples:
38113811
example:
3812-
$ref: '#/components/examples/SignatureRequestEditWithTemplateResponse'
3812+
$ref: '#/components/examples/SignatureRequestSendWithTemplateResponse'
38133813
'4XX':
38143814
description: failed_operation
38153815
content:
@@ -3880,8 +3880,6 @@ paths:
38803880
seo:
38813881
title: 'Edit Signature Request with Template | API Documentation | Dropbox Sign for Developers'
38823882
description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based off of the Template, click here.'
3883-
x-hideOn: doc
3884-
x-beta: closed
38853883
'/signature_request/files/{signature_request_id}':
38863884
get:
38873885
tags:

0 commit comments

Comments
 (0)