signatures: add docs for preserveOriginalStructure#313
Conversation
✅ Deploy Preview for criipto-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Should it not also be present here https://deploy-preview-313--criipto-docs.netlify.app/signatures/graphql/schema/#PadesDocumentInput ? |
|
Ah, we add the flag on the DocumentInput level: https://deploy-preview-313--criipto-docs.netlify.app/signatures/graphql/schema/#DocumentInput I guess technically a mistake since some of these flags only apply to PDF documents. |
Initially I assumed it might apply to other formats as well, but that sounds it was naively. There is still time to amend this - no one is using the flag, but it requires a new deployment. |
@haysch Might be more prudent? What do you think? |
Agree. Just remembered that the SDK was already published, so those need to be removed as well - so not sure if the "cost" is worth the work? |
@haysch Yeah... let's go with as-is |
nmoskaleva
left a comment
nmoskaleva
left a comment
There was a problem hiding this comment.
Looks good, some suggestions for text.
|
|
||
| ## Preserve Original Structure for PDFs in Signatures | ||
|
|
||
| Previously we attempted to recreate documents to fix errors before signing to avoid breaking signatures -or- if features, such as document ID watermarking or custom seal page template was required. |
There was a problem hiding this comment.
Suggestion:
Previously, we attempted to recreate documents to fix errors before signing and avoid breaking signatures, or when features like document ID watermarking or a custom seal page template were required.
|
|
||
| Previously we attempted to recreate documents to fix errors before signing to avoid breaking signatures -or- if features, such as document ID watermarking or custom seal page template was required. | ||
|
|
||
| However, in some scenarios the original document structure might have to be preserved, e.g., when the signing process aren't allowed to change the document or the document have been certified by third party beforehand, which would break if we were to recreate it. |
There was a problem hiding this comment.
Suggestion:
However, in some scenarios, the original document structure must be preserved. For example, if the signing process isn't allowed to change the document, or if the document has already been certified by a third party, recreating it would invalidate the certification.
|
|
||
| ### Preserve original document structure | ||
|
|
||
| By default, we attempt to fix any problems with the uploaded document before signing to avoid situations where the signatures would break -or- if features, such as document ID watermark, custom seal page template or removal of existing signatures, are used. |
There was a problem hiding this comment.
Same suggestions as in changelog.
| /** (BETA feature) When enabled, will allow any existing signatures to remain on the document. This disables recreation of the PDF document, which disables a number of features such as automatic seal placement, document id watermarking and custom seals area. */ | ||
| keepPreviousSignatures?: InputMaybe<Scalars['Boolean']['input']>; | ||
| pdf?: InputMaybe<PadesDocumentInput>; | ||
| /** (BETA feature) When enabled, preserves the original document structure. Automatically enables `keepPreviousSignatures`. This will disables features that requires recreating, such as, document watermarking and automatic seal placement. */ |
There was a problem hiding this comment.
This will disables => disables or will disable
There was a problem hiding this comment.
such as, document watermarking and automatic seal placement => such as document watermarking and automatic seal placement. (no comma)
There was a problem hiding this comment.
Will keep in mind - this is generated from our API schema, so will have to change the codebase for it to be picked up 😄
Document the use case for the new `preserveOriginalStructure` flag.
haysch
force-pushed
the
signatures/preserveOriginalStructure
branch
from
824fb12 to
5fdc9f2
Compare
3 participants
Document the use case for the new
preserveOriginalStructureflag.