users@wadl.java.net

Re: Sample Link

From: Marc Hadley <Marc.Hadley_at_Sun.COM>
Date: Thu, 12 Oct 2006 15:24:28 -0400

Nice idea. Currently you could add a link to a sample representation
inside the wadl:doc of a representation but there's no specific slot
for one elsewhere in the description. E.g.

<representation mediaType="application/xml" element="w:widget">
   <doc xml:lang="en">
     <p xmlns="...">See <a href="...">example widget</a>.</p>
   </doc>
</representation>

Seems like a sample is valuable for human consumption (I always find
an example instructive) but less so for machine consumption so that
might be sufficient ?

Marc.

On Oct 12, 2006, at 2:09 PM, Jeffrey Winter wrote:
>
> Does the current WADL spec already accommodate
> creating a link to a sample representation?
>
> If not, then I would like to see it introduced.
>
> While the <representation> element allows
> for an {element} attribute that references a
> grammar, I think it would also be helpful to
> introduce a reference to a sample representation,
> either via a <link rel="sample" href=""/> child
> element, or a {sample} attribute that contained
> a URI.
>
> This would allow for more human readable documentation
> to be generated directly from the WADL itself. The one
> issue I have with Nottingham's XSLT is the schema
> that is injected into the resultant doc can be
> overwhelming.
>
> - Jeff
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe_at_wadl.dev.java.net
> For additional commands, e-mail: users-help_at_wadl.dev.java.net
>

---
Marc Hadley <marc.hadley at sun.com>
Business Alliances, CTO Office, Sun Microsystems.