Add backwards compatibility for optional fields in Documents #157
Conversation
This file contains 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
kidonchu
approved these changes
Mar 28, 2024
| @@ -109,5 +111,8 @@ data class BarberSignature( | |||
| ) | |||
|
|
|||
| fun Document.getBarberSignature() = BarberSignature(this::class.asFieldsMap()) | |||
|
|
|||
| fun KClass<*>.getMinimumRequiredSignatureToSatisfy() = BarberSignature(asFieldsMap(includeNullableFields = false)) | |||
There was a problem hiding this comment.
Calling asFieldsMap doesn't need this::class.?
There was a problem hiding this comment.
Nope, for Document.getBarberSignature() above, we're calling this::class to get the KClass, which is how we can access its memberProperties
patpaev
deleted the
patrickp.optional-docment-fields-backwards-compatible
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When a
Documentfield is optional, we no longer validate that it's necessary in thefieldsortarget_signatureof aDocumentTemplateto be installedAlso changing the
Installed DocumentTemplate has additional fields that are not used in any target Documenterror to a warning, so that a code rollback is still possible after an optional field is added to aDocument