RE: Finalizing the IriTemplate design - serialization name (ISSUE-30 & ISSUE-17)

On 9 Okt 2014 at 09:59, Ruben Verborgh wrote:
>>  hydra:ExplicitRepresentation
> 
> +1
> 
> Something perhaps more important than the name
> (and I hope I'm not digressing by mentioning this)
> is that the vocabulary should clearly explain the term.
> I wonder if there is perhaps an :example property
> so that we can attach human-readable examples
> of instances to hydra:ExplicitRepresentation.

Oh yeah, definitely. I can't remember whether we discussed this on the list
or whether this is something I just discussed with Gregg offline but I'm a
big fan of such an example property. Clearly, this is something that helps
humans, not machines. But it allows as to build much better human-targeting
documentation out of a Hydra ApiDocumentation and also opens the door to
tools like mock servers etc.

I just checked and apparently we didn't have an issue for this yet. We'll
track this as ISSUE-74 [1] now.


Cheers,
Markus


[1] https://github.com/HydraCG/Specifications/issues/74


--
Markus Lanthaler
@markuslanthaler

Received on Thursday, 9 October 2014 13:50:10 UTC