C# Organisation Addresses Type Change
After updating the Accounting library today I was surprised to get a compilation error with an organisation. Looking into it, it looks like the type definition for Organisation.Addresses has changed from a List<Address> to List<AddressForOrganisation> (commit f9454f8b, Dec 14 2020).
I guess I expected the api would only make 'adding' changes, whereas this seems like a break to an existing contract. We store the full-type with a saved object so this is a slightly larger pain than just a recompile and I wanted to check this was intended before updating our stored information.
Was this intended and what is Xero's policy on api evolution and breaking changes?
I guess I expected the api would only make 'adding' changes, whereas this seems like a break to an existing contract. We store the full-type with a saved object so this is a slightly larger pain than just a recompile and I wanted to check this was intended before updating our stored information.
Was this intended and what is Xero's policy on api evolution and breaking changes?
1
Replies
Hi Chtest,
This change was generated into the DotNet SDK based on a release of the OpenAPI Spec: https://github.com/XeroAPI/Xero-OpenAPI/pull/338
It was a breaking change and should have been versioned as such in the release of your specific SDK. Apologies for the inconvenience.
This change was generated into the DotNet SDK based on a release of the OpenAPI Spec: https://github.com/XeroAPI/Xero-OpenAPI/pull/338
It was a breaking change and should have been versioned as such in the release of your specific SDK. Apologies for the inconvenience.