users@jersey.java.net

[Jersey] Re: [jsr339-experts] [OT] Refreshing WADL Spec ?

From: Sergey Beryozkin <sberyozkin_at_talend.com>
Date: Fri, 25 Jul 2014 17:16:44 +0300

Hi Santiago

Thanks for redirecting,
On 25/07/14 16:02, Santiago Pericas-Geertsen wrote:
>
> [Moving to Jersey alias ...]
>
> People do ask for something like WADL from time to time. But I'm also wondering if an XML-based format is still the way to go. Perhaps it's time to JSONify this? Use JSON schema?
>
WADL appears to be very complete as far as describing XML services is
concerned. It is also good in supporting the description of non-XML
formats such as form payloads (via representation parameters).

It is really the description of these non-XML formats where the
questions arise. I have to admit IMHO it's quite perfect even in the
current state, as far as the description of simple non-XML formats is
concerned.

Describing multipart payloads is problematic. The other question users
ask: can we have List<String> generated if we have a single repetitive
response representation parameter, questions like that.

I agree the other question is what to do about describing JSON services.
JSON schema does exist, and WADL is perfect in describing the resource
tree and complex services may have both XML and JSON supported. Hence we
decided to optionally report WADL docs in JSON format with the grammar
linking to JSON.schema resources:
"grammar":"http://resource/json.schema"
This can be inlined too.

IMHO may save on creating a new specification for describing JSON
services only, a section in the updated WADL document suggesting that
WADL may be reported in JSON format using the approach described above
(or similar one) might do.


Cheers, Sergey

> -- Santiago
>
> On Jul 25, 2014, at 6:05 AM, Sergey Beryozkin <sberyozkin_at_talend.com> wrote:
>
>> Hi
>>
>> It is off-topic, but I thought it would reach someone in the Jersey team here better.
>>
>> Would there be any interest in refreshing a bit a WADL spec ?
>> We have a steady stream of JIRAs reported with users keen to use it to describe their JAX-RS services. There are few gray areas in the spec, and few basic clarifications would work well, no need to start a long and sophisticated process.
>>
>> Can someone from a Jersey team consider leading this would be 'revival' given that WADL was created by Marc H ? If yes then I'd support it, may be we can discuss it off-line ?
>>
>> Bill, let me say you'd be massively welcome too :-)
>>
>> Cheers, Sergey
>>
>