Re: JSON Results doc : First complete draft ready

On 2011-05-17, at 14:54, Andy Seaborne wrote:
> 
> On 17/05/11 14:23, Axel Polleres wrote:
>> Just to understand the issue about warnings/comments...
>> 
>>>> Are there any examples of system that do add anything to the JSON format?
>>> 
>>> Yeah, 4store apparently, it adds a "warnings": block after "results":, and puts an array of strings there: https://github.com/garlik/4store/blob/master/src/frontend/results.c#L1909
>>> 
>>> I'm not sure who did that, but it's quite a good idea!
>> 
>> Wouldn't that be non-conformant/problematic with the current spec?
>> 
>> As a work-around,  could we allow to "add more keys" on top-level, i.e. do we/could we
>> (i) state somewhere that adding keys except "results","boolean" on top level is allowed
>> and (ii) give "warnings:" block from 4store as an (informative) example?
>> 
>> Axel
> 
> (i) is just as non-conformant to the Note/spec.
> 
> Given the discussions awhile ago about the format of error messages, so they can be processed and displayed to people or used by software to act on them (and also language issues), I think any loose, under-constrained feature merely begs the question of format.  An example in a spec is tantamount to specification.
> 
> So, at most, note other keys may be present, or leave as-is.

+1, for the benefit of posterity.

- Steve

-- 
Steve Harris, CTO, Garlik Limited
1-3 Halford Road, Richmond, TW10 6AW, UK
+44 20 8439 8203  http://www.garlik.com/
Registered in England and Wales 535 7233 VAT # 849 0517 11
Registered office: Thames House, Portsmouth Road, Esher, Surrey, KT10 9AD

Received on Tuesday, 17 May 2011 15:02:27 UTC