CKAN: Ticket #954: Change API JSON response format to include errors etc

owner set

thejimmyg — Tue, 15 Mar 2011 19:25:06 GMT

owner set to thejimmyg

I'll look at this for a v3 API with kindly as part of the dictization. It also addresses some potential XSS issues in the API we've discovered.

repo, theme set

thejimmyg — Fri, 18 Mar 2011 11:24:26 GMT

repo set to ckan
theme set to none

What would also be really nice is a help key in the response which was always returned unless a query parameter of ?help=False was sent.

The help text could explain what the response meant but more importantly would show examples of other calls you can make with the IDs returned such that the whole API is discoverable without anyone ever needing to read any docs! It also means the API documentation is more likely to be up to date since it will be obvious to developers when it isn't.

With help=False, the JSON can have all whitespace stripped too for production use.

I also think there should be no distinction between GET and POST so that people can easily link to API calls if they want to.

milestone changed

thejimmyg — Mon, 18 Apr 2011 09:21:53 GMT

milestone changed from ckan-v1.4 to ckan-v1.4-sprint-7

David Raznick has implemented JSON errors for the v1 and v2 API, we'll look at this over the next few weeks.

summary, milestone changed

thejimmyg — Fri, 08 Jul 2011 14:15:31 GMT

summary changed from Change API JSON response format to include errors etc to API version 3
milestone changed from ckan-v1.5 to ckan-backlog

See also this proposal about "inlining" extras fields #972.

David Raznick and I have also agreed that for API 3, each call to the logic layer will return an object (basically a dictionary) rather than using Exceptions. This means the return values from the logic layer can exactly mirror the JSON data strucutres returned via the API.

The help values can come from the docstrings of the logic layer functions.

summary, description, milestone changed

thejimmyg — Fri, 08 Jul 2011 14:19:42 GMT

summary changed from API version 3 to [super] API version 3
description modified (diff)
milestone changed from ckan-backlog to ckan-v1.5

owner, status changed

dread — Mon, 01 Aug 2011 10:07:28 GMT

owner changed from thejimmyg to kindly
status changed from new to assigned

rgrp — Tue, 13 Sep 2011 21:20:55 GMT

@kindly: can you update here. My impression is that lots was done but the current ticket description bears little relation to what was done. Suggest we move current content to a new ticket and update this with a short description of what *was* done and then close -- does this sound sensible?

status changed; resolution set

kindly — Tue, 01 Nov 2011 10:19:04 GMT

status changed from assigned to closed
resolution set to fixed

This is basically the complete now with documentation. The child tickets no longer seem to fit and are not essential for completion.