Re: [oslc-core] Resource Preview Proposal

["Jim Amsden" <jamsden@us.ibm.com>]

After reviewing all the issues and options,
which are discussed in detail in https://wiki.oasis-open.org/oslc-core/V2Compatibility#preview,
I'd like to make the following simple proposal for Resource Preview:

1. Preview Discovery

To preserve compatibility with OSLC2,
preview discovery must continue to support the Accept: application/x-oslc-compact+xml
header to get the Compact resource. This usage will be noted as deprecated.
OLSC3 clients should use the Link header with rel="http://open-services.net/ns/core#Compact"
and the Prefer header with include="http://open-services.net/ns/core#PreferCompact”,
using the Accept header with standard MIME types such as text/turtle, application/rdf+xml,
application/ld+json, etc. to get the Compact resource in the desired format.

2. Preview Resource Representation 

OSLC3 must continue to support the OSLC2
Compact resource XML representation. This format will be noted as deprecated.
OSLC3 clients should use the Accept and Prefer headers to get the compact
resource in Turtle or JSON format. Servers may support other formats such
as application/rdf+xml and application/ld+json.

3. Preview Resize

OSLC3 will continue to support the OSLC2
oslc-preview-height resize message, but this usage will be noted as deprecated.
OSLC3 servers should use the oslc-resize message. OSLC3 servers should
send both the oslc-preview-height and oslc-resize messages if OSLC2 compatibility
is a requirement.

This results in very few changes to
Resource Preview - just including the x- MIME type and XML format for the
OSLC2 Compact resource, and handling the oslc-preview-height resize message
for OSLC2 compatibility.

In order to complete the edits as soon
as possible, we can try an electronic vote on this proposal.


Jim Amsden, Senior Technical Staff Member
OSLC and Linked Lifecycle Data
919-525-6575