Change Log for Resource Representation

1

I’m finding the resource representation included for the various API calls very useful as with some modifications they can be used to automatically generate classes that allow for easy deserialization of API results. However, this can become problematic when the contents of the response change as they have a couple of times since I’ve been using the beta.

Going forward is there any chance that changes to these resources will be documented? Especially when the service is out of beta.

For the record (and in case it is of use for anyone else) I’ve been using http://jsonutils.com/ to create classes based on the resource representation. The only issue is that it thinks everything is a string because it thinks it’s creating based on data rather than a representation of that data and all interperates all the variable types enclosed in quotes are actually strings.

A quick fix for this is to search and replace “integer” with 0 and “boolean” with true. Dates I’ve had to change by hand.

1 Like
2

We’ve been using various forms, such as Swagger, to describe the interfaces to the API. At present these are not fit for publication - however they do work, as all the developer hub documentation is generated directly from these interface description documents.

We are in the process of cleaning up these documents, and will be publishing them later, before we get out of beta.