Recommend to use cache revalidation for ApiDocumentation

In the spec we say

"Keep in mind that operations specified in an <i>ApiDocumentation</i> may 
fail at runtime as either resources or the <i>ApiDocumentation</i>
itself have changed since they have been retrieved. A simple strategy to 
try to recover from such an error is to reload the
<i>ApiDocumentation</i>."

People could take "reload" literally and really request the entire 
ApiDocumentation everytime. Suggest to make it more explicit that we mean 
to cache the ApiDocumentation properly:

... "A simple strategy to avoid such an error without affecting performance 
is to deliver the <i>ApiDocumentation</i> with "Last-Modified" cache-info 
and require the client to revalidate."

See also [1]

[1] https://github.com/HydraCG/Specifications/pull/94

Received on Saturday, 24 January 2015 22:07:17 UTC