fix(accounting): make CreditNote SentToContact writable#827
Open
KSHITIZ6341 wants to merge 1 commit into
Open
Conversation
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
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.
Description
Remove the stale
readOnly: truemarker fromCreditNote.SentToContact.The live Accounting API accepts this field when creating or updating approved credit notes, and the wording and examples were updated for that behavior in #616. Leaving the schema marker in place still tells OpenAPI generators to omit or restrict the setter, so official SDK consumers cannot use the supported field through generated models.
This is an additive request-schema correction. It does not change the wire format or existing response behavior.
Fixes #826.
Good catch by @syl222, especially tracing the mismatch back to #616 and confirming both create and update behavior through the API Explorer.
Validation
CreditNote.SentToContactcontract assertion: writable and booleanbash scripts/api-diff/api-diff.test.sh: 9 tests passedoasdiff v1.23.0 breaking --fail-on WARN: no breaking changesoasdiff v1.23.0 changelog: informational changes only, including writable request support for create and updateyamllint -c .yamllint.yml xero_accounting.yamlgit diff --checkSpectral was also attempted with the repository ruleset, but the current ruleset/tool combination crashes on both this branch and unmodified
origin/masterwithCannot read properties of null (reading 'enum').