Skip to content

Add edit&resend to OpenAPI docs (#490) #491

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jtreminio-dropbox merged 1 commit into from
May 15, 2025
Merged

Add edit&resend to OpenAPI docs (#490) #491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 4 additions & 12 deletions openapi-raw.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3428,7 +3428,7 @@ paths:
$ref: '#/components/schemas/SignatureRequestGetResponse'
examples:
example:
$ref: '#/components/examples/SignatureRequestEditResponse'
$ref: '#/components/examples/SignatureRequestSendResponse'
4XX:
description: failed_operation
content:
Expand Down Expand Up @@ -3499,8 +3499,6 @@ paths:
seo:
title: '_t__SignatureRequestEdit::SEO::TITLE'
description: '_t__SignatureRequestEdit::SEO::DESCRIPTION'
x-hideOn: doc
x-beta: closed
'/signature_request/edit_embedded/{signature_request_id}':
put:
tags:
Expand Down Expand Up @@ -3547,7 +3545,7 @@ paths:
$ref: '#/components/schemas/SignatureRequestGetResponse'
examples:
example:
$ref: '#/components/examples/SignatureRequestEditEmbeddedResponse'
$ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse'
4XX:
description: failed_operation
content:
Expand Down Expand Up @@ -3617,8 +3615,6 @@ paths:
seo:
title: '_t__SignatureRequestEditEmbedded::SEO::TITLE'
description: '_t__SignatureRequestEditEmbedded::SEO::DESCRIPTION'
x-hideOn: doc
x-beta: closed
'/signature_request/edit_embedded_with_template/{signature_request_id}':
put:
tags:
Expand Down Expand Up @@ -3663,7 +3659,7 @@ paths:
$ref: '#/components/schemas/SignatureRequestGetResponse'
examples:
example:
$ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateResponse'
$ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse'
4XX:
description: failed_operation
content:
Expand Down Expand Up @@ -3733,8 +3729,6 @@ paths:
seo:
title: '_t__SignatureRequestEditEmbeddedWithTemplate::SEO::TITLE'
description: '_t__SignatureRequestEditEmbeddedWithTemplate::SEO::DESCRIPTION'
x-hideOn: doc
x-beta: closed
'/signature_request/edit_with_template/{signature_request_id}':
put:
tags:
Expand Down Expand Up @@ -3779,7 +3773,7 @@ paths:
$ref: '#/components/schemas/SignatureRequestGetResponse'
examples:
example:
$ref: '#/components/examples/SignatureRequestEditWithTemplateResponse'
$ref: '#/components/examples/SignatureRequestSendWithTemplateResponse'
4XX:
description: failed_operation
content:
Expand Down Expand Up @@ -3850,8 +3844,6 @@ paths:
seo:
title: '_t__SignatureRequestEditWithTemplate::SEO::TITLE'
description: '_t__SignatureRequestEditWithTemplate::SEO::DESCRIPTION'
x-hideOn: doc
x-beta: closed
'/signature_request/files/{signature_request_id}':
get:
tags:
Expand Down
30 changes: 14 additions & 16 deletions openapi-sdk.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3414,7 +3414,7 @@ paths:
description: |-
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.

**NOTE:** Edit and resend will not deduct your signature request quota.
**NOTE:** Edit and resend *will* deduct your signature request quota.
operationId: signatureRequestEdit
parameters:
-
Expand Down Expand Up @@ -3455,7 +3455,7 @@ paths:
$ref: '#/components/schemas/SignatureRequestGetResponse'
examples:
example:
$ref: '#/components/examples/SignatureRequestEditResponse'
$ref: '#/components/examples/SignatureRequestSendResponse'
'4XX':
description: failed_operation
content:
Expand Down Expand Up @@ -3526,14 +3526,15 @@ paths:
seo:
title: 'Edit Signature Request | REST API | Dropbox Sign for Developers'
description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest with the submitted documents, click here.'
x-hideOn: doc
x-beta: closed
'/signature_request/edit_embedded/{signature_request_id}':
put:
tags:
- 'Signature Request'
summary: 'Edit Embedded Signature Request'
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.'
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.

**NOTE:** Edit and resend *will* deduct your signature request quota.
operationId: signatureRequestEditEmbedded
parameters:
-
Expand Down Expand Up @@ -3574,7 +3575,7 @@ paths:
$ref: '#/components/schemas/SignatureRequestGetResponse'
examples:
example:
$ref: '#/components/examples/SignatureRequestEditEmbeddedResponse'
$ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse'
'4XX':
description: failed_operation
content:
Expand Down Expand Up @@ -3644,14 +3645,15 @@ paths:
seo:
title: 'Edit Embedded Signature Request | Dropbox Sign for Developers'
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.'
x-hideOn: doc
x-beta: closed
'/signature_request/edit_embedded_with_template/{signature_request_id}':
put:
tags:
- 'Signature Request'
summary: 'Edit Embedded Signature Request with Template'
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.'
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.

**NOTE:** Edit and resend *will* deduct your signature request quota.
operationId: signatureRequestEditEmbeddedWithTemplate
parameters:
-
Expand Down Expand Up @@ -3690,7 +3692,7 @@ paths:
$ref: '#/components/schemas/SignatureRequestGetResponse'
examples:
example:
$ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateResponse'
$ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse'
'4XX':
description: failed_operation
content:
Expand Down Expand Up @@ -3760,8 +3762,6 @@ paths:
seo:
title: 'Signature Request with Template | Dropbox Sign for Developers'
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.'
x-hideOn: doc
x-beta: closed
'/signature_request/edit_with_template/{signature_request_id}':
put:
tags:
Expand All @@ -3770,7 +3770,7 @@ paths:
description: |-
Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter.

**NOTE:** Edit and resend will not deduct your signature request quota.
**NOTE:** Edit and resend *will* deduct your signature request quota.
operationId: signatureRequestEditWithTemplate
parameters:
-
Expand Down Expand Up @@ -3809,7 +3809,7 @@ paths:
$ref: '#/components/schemas/SignatureRequestGetResponse'
examples:
example:
$ref: '#/components/examples/SignatureRequestEditWithTemplateResponse'
$ref: '#/components/examples/SignatureRequestSendWithTemplateResponse'
'4XX':
description: failed_operation
content:
Expand Down Expand Up @@ -3880,8 +3880,6 @@ paths:
seo:
title: 'Edit Signature Request with Template | API Documentation | Dropbox Sign for Developers'
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.'
x-hideOn: doc
x-beta: closed
'/signature_request/files/{signature_request_id}':
get:
tags:
Expand Down
Loading