Breaking changes in JSON format

35 views
Skip to first unread message

Alex Fomin

unread,
Nov 3, 2011, 1:19:02 PM11/3/11
to devtarge...@googlegroups.com
Hi

We are going to introduce breaking changes to our REST API JSON response format. This change is not huge to make us change the API version from v1 to v2, but still can break any API clients that use JSON response format.
Changes will affect inner collections - the representation of inner collections will be changed from arrays to collections:

now:
{"Id":1, "Name":"User story", "Bugs: :[{"Id":1},{"Id":"2"}] }

will be
{"Id":1, "Name":"User story", "Bugs": { "items":[{"Id":1},{"Id":"2"}]} }

We understand that this change can be painful for some of our users, but it is required to fix a potentially major bug in inner collections representation.If you have any serious concerns about the issue, please let us know.

Sorry for inconvenience,
Alex, TP Team

Matthieu LAGARRIGUE

unread,
May 17, 2013, 3:20:51 PM5/17/13
to devtarge...@googlegroups.com
Hi,

I noticed that not all collections are affected by this modification :
ie : CustomFields  cf. http://md5.tpondemand.com/api/v1/requests/?format=json&where=%28Id%20eq%20140%29%20&include=[CustomFields]

Can you tell me which collections are either concerned or not concerned by this change.

I will do a trick to manage customfield during your investigations.

Thanks

Matthieu Lagarrigue

Alex Fomin

unread,
May 25, 2013, 2:48:58 PM5/25/13
to devtarge...@googlegroups.com
Hi,

In fact, CustomFields are not a resource collection, but a set of named values. So it is the only exclusion from Resource collection format.

Thanks,
Alex
Reply all
Reply to author
Forward
0 new messages