Inconistency in REST API documentation and implementation

Has anyone noticed/faced the number of inconsistencies in terms of documentation states the response element will be an array but actually returned an object from server.

An example as below, spec says collection will be array

but actual response is object.

Its difficult to come up with correct schema classes due to these inconsistencies.

Find more posts tagged with

Comments

Jim Hewitt

Hello Mujahid,

I know there are some inconsistencies in the documentation. We've recently started work on revamping the REST API documentation to automatically generate it which should address issues like this. I don't currently have a date for when the work will be completed at the current time however.

Greg Griffiths

I would recommend logging them as bugs with the OT Support Team then they can have them on the list of things to look at otherwise they may be missed in the review that @Jim Hewitt mentions.