docs(turbosign): document conditional (IF/THEN) fields for the API and SDKs - #150
Merged
amitsharma-turbodocx merged 1 commit intoAug 19, 2026
Merged
Conversation
…d SDKs
Adds a "Conditional (IF/THEN) Fields" guide and documents the `metadata` field
object (fieldKey on a controlling checkbox; conditional { controllingFieldKey,
operator, action } on a dependent field) in the API Signatures reference, the
Bulk API note, the five SDK reference pages, and the prepare-for-signing code
samples. Covers show vs unlock, the is_not_checked operator, the
InvalidConditionalRule 400, and the fail-open behavior for a dangling key.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Author
|
Coordinated conditional-fields rollout — sibling PRs: TurboDocx/SDK#71 · TurboDocx/n8n-nodes-turbodocx#31 · TurboDocx/quickstart#24 |
This was referenced Aug 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents TurboSign conditional (IF/THEN) fields for API and SDK users.
What changed
TurboSign/Conditional Fields.md— concept, themetadatacontract,showvsunlock, theis_not_checkedoperator, worked examples, validation + fail-open behavior, and tips.TurboSign/API Signatures.md— addsmetadata(withfieldKeyand nestedconditional.{controllingFieldKey, operator, action}) to the Field reference + a worked example.TurboSign/API Bulk Signatures.md— note that conditional metadata works in bulk.SDKs/{javascript,python,php,go,java}.md) — themetadata/conditionaltypes and a per-language snippet, matching each SDK's real API (Go structs, PHP enums, JavaFieldMetadatafactories, JS/Python plain objects).metadataJSON on the field).Documents the
400 InvalidConditionalRule(malformed rule →{ message, type }) and the fail-open behavior when acontrollingFieldKeymatches no checkbox.Verification
npm run buildsucceeds (pre-existing unrelated anchor warnings only).Notes
Base is
developper repo policy. Part of a coordinated conditional-fields rollout across the TurboDocx public repos (SDK, n8n node, quickstart) — sibling PRs linked in a follow-up comment.