Notices

Copyright © OASIS Open 2019. All Rights Reserved.

All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.

This specification is published under the Attribution 4.0 International (CC BY 4.0). Portions of this specification are also provided under the Apache License 2.0.

All contributions made to this project have been made under the OASIS Contributor License Agreement (CLA).

For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Open Projects IPR Statements page.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Open Project or OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.

This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Project Specification or OASIS Standard, to notify the OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.

OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Open Project that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so.

OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Open Project Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.

The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see https://www.oasis-open.org/policies-guidelines/trademark for above guidance.

Table of Contents

1. Introduction

This section is non-normative.

This specification describes how a client application can display links and embed rich previews for resources from other applications. Links may have a label and an icon, and previews are HTML markup provided by a server and displayed directly inside the client application.

Fig. 1 Preview for a Link

Previews often appear as a pop-up when a user mouses over a link as in Fig. 1 Preview for a Link. However, a client may wish to display a preview differently depending on the kind of application, the size of the screen, and the capabilities of the device. For example, a desktop application on a PC might handle previews differently than a mobile application running on a small touchscreen.

Servers can provide both small and large previews. A client might show a small preview first, then if the user gestures, show additional details from the large preview. Servers suggest sizes for previews, and previews can ask to be resized after they are displayed.

A client only needs to know the URI of a resource to display a link and a preview. It doesn't need to know anything else about the resource. Clients don't need to copy, synchronize, or cache any data.

1.1 Terminology

Terminology uses and extends the terminology and capabilities of OSLC Core Overview, W3C Linked Data Platform [LDP], W3C's Architecture of the World Wide Web [WEBARCH], and Hyper-text Transfer Protocol [HTTP11].

The following terms are used in discussions of previews:

Compact resource
A resource describing how to display a link and preview for another, associated resource.
Preview
An HTML representation of a resource that can be embedded in another user interface.

1.2 References

1.2.1 Normative references

[CSS21]
Bert Bos; Tantek Çelik; Ian Hickson; Håkon Wium Lie et al. Cascading Style Sheets Level 2 Revision 1 (CSS 2.1) Specification. 7 June 2011. W3C Recommendation. URL: https://www.w3.org/TR/CSS2/
[HTTP11]
R. Fielding, Ed.; J. Reschke, Ed.. Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing. June 2014. Proposed Standard. URL: https://httpwg.org/specs/rfc7230.html
[JSON-LD]
Manu Sporny; Gregg Kellogg; Markus Lanthaler. JSON-LD 1.0. 16 January 2014. W3C Recommendation. URL: https://www.w3.org/TR/json-ld/
[JSONSchema]
F. Galiegue; K. Zyp. JSON Schema. Informational. URL: http://tools.ietf.org/html/draft-zyp-json-schema-04
[LDP]
Steve Speicher; John Arwe; Ashok Malhotra. Linked Data Platform 1.0. 26 February 2015. W3C Recommendation. URL: https://www.w3.org/TR/ldp/
[OSLCUIPreview20]
S. Bosworth. OSLC Core 2.0 - UI Preview. Finalized. URL: http://open-services.net/bin/view/Main/OslcCoreUiPreview
[RFC2119]
S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. March 1997. Best Current Practice. URL: https://tools.ietf.org/html/rfc2119
[RFC4627]
D. Crockford. The application/json Media Type for JavaScript Object Notation (JSON). July 2006. Informational. URL: https://tools.ietf.org/html/rfc4627
[RFC5988]
M. Nottingham. Web Linking. October 2010. Proposed Standard. URL: https://tools.ietf.org/html/rfc5988
[RFC7240]
J. Snell. Prefer Header for HTTP. June 2014. Proposed Standard. URL: https://tools.ietf.org/html/rfc7240
[turtle]
Eric Prud'hommeaux; Gavin Carothers. RDF 1.1 Turtle. 25 February 2014. W3C Recommendation. URL: https://www.w3.org/TR/turtle/
[webmessaging]
Ian Hickson. HTML5 Web Messaging. 19 May 2015. W3C Recommendation. URL: https://www.w3.org/TR/webmessaging/

1.2.2 Informative references

[WEBARCH]
Ian Jacobs; Norman Walsh. Architecture of the World Wide Web, Volume One. 15 December 2004. W3C Recommendation. URL: https://www.w3.org/TR/webarch/

1.3 Typographical Conventions and Use of RFC Terms

As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.

The key words MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL in this specification are to be interpreted as described in [RFC2119].

The namespace for OSLC Core is http://open-services.net/ns/core#.

Commonly used namespace prefixes:

    @prefix dcterms: <http://purl.org/dc/terms/>.
    @prefix oslc:    <http://open-services.net/ns/core#>.
    @prefix rdf:     <http://www.w3.org/1999/02/22-rdf-syntax-ns#>.
    @prefix xsd:     <http://www.w3.org/2001/XMLSchema#>.

2. Motivation

This section is non-normative.

Applications often display links to related resources from other applications. For example, a quality management application might show a link to a related defect when displaying a test result. In some cases, the quality management application only has a URI pointing to the defect. The application needs a way to display the link with an appropriate label and icon so testers find out the status of the defect without leaving the quality management application.

Compact resources and resource preview provide these capabilities. Clients can discover the link label and a resource icon given only the resource URI. The client can then use the link label and icon as a means of displaying the link in a meaningful way. Previews allow users to see see information about related resources quickly without leaving the application they're in, even when the resources are from another server.

3. Working with Previews

This section is non-normative.

To enable previews of a resource, servers supply an associated Compact resource describing the preview. The Compact resource can contain a link label, icon, and small and/or large previews of the resource. Compact resources always have a JSON representation [RFC4627], but they can also have other representations such as XML, Turtle [turtle] or JSON-LD [JSON-LD]. Here is a simple example of a Compact resource:

Example 1: A Compact Resource
{
    "title": "Screenshot of the problem",
    "icon": "http://example.com/icons/attachment.jpg",
    "smallPreview": {
        "document": "http://example.com/bugs/324/screenshot?preview=small"
    }
}

To display a link with a label or a preview of a resource, clients request its Compact resource. The URI of the Compact resource is found through an HTTP Link header [RFC5988] in HTTP responses to the resource URI. Alternatively, a client can use a Prefer request header in requests for the resource to ask for its Compact resource. The server can then inline the Compact resource directly in the response, saving an HTTP request.

The Compact resource may contain small and/or large previews. Each preview can have size hints and a link to an HTML representation designed to be embedded in other user interfaces. To display the preview, the client creates an HTML iframe element in its user interface and sets the iframe element's src to the preview document URI. This sandboxes the preview from other content in the client application and allows the preview to use its own stylesheets and scripts.

3.1 Getting the Compact Resource

This section is non-normative.

Clients can discover Compact resources in three ways:

  1. Discovering Compact Resources Using the HTTP Accept Header
  2. Discovering Compact Resources Using the HTTP Link Header
  3. Discovering Compact Resources Using the HTTP Prefer Header

The HTTP Accept header allows clients to access previews using the application/x-oslc-compact+xml MIME type extension to request the Compact resource representation for a URI instead of the content of the resource itself. This usage is considered deprecated and is included only to maintain compatibility with [OSLCUIPreview20].

The HTTP Link header allows servers to offer previews for any resource, even binary resources with no RDF or JSON representations. To discover previews using the Link header, a client typically performs an HTTP HEAD or OPTIONS request on the resource URI. The response contains a Link header with the URI of the Compact resource. The client then performs a GET request on the Compact URI to retrieve the Compact resource.

Clients might instead use the HTTP Prefer header to get the Compact resource in a single HTTP request. If the client is confident that the resource has a preview, it makes an HTTP GET request on the resource URI using the return=representation preference [RFC7240] and an include parameter [LDP] asking for the Compact resource to be included in the response. The provider responds with a minimal representation of the resource and the Compact resource in the HTTP response body.

3.1.1 Discovering Compact Resources Using the HTTP Accept Header

This section is non-normative.

[OSLCUIPreview20] utilizes a MIME type extension, application/x-oslc-compact+xml to allow servers to use content negotiation with the HTTP Accept header to access the Compact representation of a resource instead of the content of the resource itself.

Example 2: Requesting the Compact Resource
GET /bugs/324/screenshot HTTP/1.1
Host: example.com
Accept: application/x-oslc-compact+xml

This returns a Compact resource with Content-Type: application/x-oslc-compact+xml as defined in Appendix B. XML Representation Format.

3.1.2 Discovering Compact Resources Using the HTTP Link Header

This section is non-normative.

In responses to HTTP requests for resources that have a preview, servers include a Link header [RFC5988] where the link relation is http://open-services.net/ns/core#Compact and the target URI is the URI of the Compact resource.

Example 3: Requesting the Resource Headers
HEAD /bugs/324/screenshot HTTP/1.1
Host: example.com
Example 4: Response with a Compact Link

Clients can request the Compact resource using the target URI of the Link header.

Example 5: Requesting the Compact Resource
GET /bugs/324/screenshot?compact HTTP/1.1
Host: example.com
Accept: application/json
Example 6: JSON Compact Response
HTTP/1.1 200 OK
Content-Length: 192
Content-Type: application/json; charset=UTF-8
ETag: "3bf6fbc90e11b3c2cc30acb534b452ea"
Vary: Accept,Accept-Language

{
    "title": "Screenshot of the problem",
    "shortTitle": "screenshot.png",
    "smallPreview": {
        "document": "http://example.com/bugs/324/screenshot?preview=small"
    }
}

Servers can also return a Link header in response to successful requests that create resources. This allows the client to get the Compact resource URI for new resources without making additional requests. Note that servers set the Link context using an anchor parameter if the request URI is not the same as the newly-created resource URI.

Example 7: Creating a Resource
POST /bugs HTTP/1.1
Host: example.com
Content-Length: 153
Content-Type: text/turtle

@prefix dcterms: <http://purl.org/dc/terms/> .

<>      a              <http://example.com/ns#Bug> ;
        dcterms:title  "Something went wrong" .
Example 8: Creation Response with a Compact Link
HTTP/1.1 201 Created
Content-Length: 0
Link: <http://example.com/bugs/478?compact>; rel="http://open-services.net/ns/core#Compact"; anchor="http://example.com/bugs/478"
Location: http://example.com/bugs/478

3.1.3 Discovering Compact Resources Using the HTTP Prefer Header

This section is non-normative.

Clients can request a Compact resource by making an HTTP GET request to the target resource's URI using the return=representation preference of the HTTP Prefer request header [RFC7240] and include parameter [LDP] value http://open-services.net/ns/core#PreferCompact. Servers supporting resource preview must support this method of discovery for resources with RDF or JSON representations.

Example 9: Requesting the Compact Resource Using the Prefer Header
GET /bugs/324 HTTP/1.1
Host: example.com
Accept: application/json
Prefer: return=representation; include="http://open-services.net/ns/core#PreferCompact"

If the provider supports a preview for this resource and the request is successful, the response includes the Compact resource in its body.

The response content type is negotiated using the HTTP Accept request header. If the negotiated content type is application/json, the response body is a JSON object. The top-level JSON object has a compact property whose value is the JSON object describing the Compact resource in Appendix A. JSON Representation Format. The JSON may include other properties.

Example 10: Preference-Applied Response
HTTP/1.1 200 OK
Content-Length: 315
Content-Type: application/json; charset=UTF-8
ETag: "f9d76afe5fbed1655c5768906db8958a"
Preference-Applied: return=representation
Vary: Accept,Accept-Language,Prefer

{
    "compact": {
        "title": "324: Need a fix <em>NOW</em>",
        "icon": "http://example.com/icons/defect.jpg",
        "largePreview": {
            "document": "http://example.com/bugs/324?preview=large",
            "hintHeight": "250px",
            "hintWidth": "400px"
        }
    }
}

Services may include a JSON-LD context in an application/json response. Clients who prefer RDF should request text/turtle or application/ld+json using the HTTP Accept request header, rather than application/json.

Example 11: JSON Response with a JSON-LD Context
HTTP/1.1 200 OK
Content-Length: 788
Content-Type: application/json; charset=UTF-8
ETag: "d53d19be87fa9c61043c70bd91413dab"
Preference-Applied: return=representation
Vary: Accept,Accept-Language,Prefer

{
    "@id": "http://example.com/bugs/324",
    "@type": "http://example.com/ns#Bug",
    "@context": "http://docs.oasis-open.org/oslc-core/oslc-core/v3.0/cs01/contexts/preview.jsonld",
    "compact": {
        "@id": "http://example.com/bugs/324?compact",
        "@type": "http://open-services.net/ns/core#Compact",
        "title": "324: Need a fix <em>NOW</em>",
        "shortTitle": "324",
        "icon": "http://example.com/icons/defect.jpg",
        "iconTitle": "Defect",
        "iconAltLabel": "Defect",
        "largePreview": {
            "document": "http://example.com/bugs/324?preview=large",
            "hintHeight": "250px",
            "hintWidth": "400px"
        },
        "smallPreview": {
            "document": "http://example.com/bugs/324?preview=small"
        }
    }
}

3.2 Displaying Previews

This section is non-normative.

When displaying a preview inside another HTML-based presentation, clients create an iframe element, setting its src attribute to the preview's document URI. Previews can contain HTML, stylesheets, and scripts and might not render properly outside of an iframe. Using the iframe element also sandboxes the preview, avoiding cross-site scripting vulnerabilities.

Fig. 2 Preview iframe

Typically, the server does not include the icon or title in the preview itself. The client can display these as needed. In Fig. 2 Preview iframe, the preview document is the content inside the yellow, dashed lines.

Resources can have both a small and large preview, and clients can choose which to display. Some clients display the small preview initially and let users expand to the large preview using a button or "Show more" link.

The Compact resource can include oslc:hintHeight and oslc:hintWidth properties for each preview. Values for oslc:hintWidth and oslc:hintHeight are expressed in length units specified in [CSS21].

Servers can also request dynamic resizing for small and large previews. The communication of dynamic size information happens within a web browser. JavaScript code running in the preview iframe sends a message that is received and acted upon by JavaScript code running in the iframe's parenting window. This cross-frame communication is done using HTML 5 postMessage. Dynamic resizing will not work inside browsers that do not support postMessage.

A resize message begins with oslc-resize: followed by a JSON object describing the dimensions using properties oslc:hintHeight and oslc:hintWidth.

JSON Property Name Type Occurs Description
oslc:hintHeight String Zero-or-one Preferred height of the preview. Values are expressed using length units as specified in [CSS21].
oslc:hintWidth String Zero-or-one Preferred width of the preview. Values are expressed using length units as specified in [CSS21].

For example, the following message requests that the preview be resized to height of 277 pixels and a width of 400 pixels.

Example 12: Dyanmic Resize Message
oslc-resize:{"oslc:hintHeight": "277px", "oslc:hintWidth": "400px"}

The following JavaScript example sends a resize request to the parent window.

Example 13: JavaScript postMessage Example
var size = {
    'oslc:hintHeight': '277px',
    'oslc:hintWidth': '400px'
};

if (window.postMessage && window.parent)  {
    window.parent.postMessage('oslc-resize:' + JSON.stringify(size), "*");
}

Clients can ignore a server's size hints and use other values. For instance, a client might choose another size if the preview is too large for the window.

4. Preview Guidance

This section is non-normative.

The following guidance is suggested for Client display of a resource link and rich previews. For purposes of this discussion, assume source resource A has a URI property that refers to target resource B:

4.3 Using the Compact representation title, short title, and icon

This section is non-normative.

A Compact representation of the resource may contain a more accurate and slightly richer label for a target resource (dcterms:title element), a short-form title for the resource (oslc:shortTitle), and a corresponding image (oslc:icon), possibly chosen from a set with different sizes (oslc:iconSrcSet), all of which may be based on the current state of the target resource. If this becomes known to the Client, the client should assume that this information is better and use it in forming the hyperlink that is displayed to the user. When available, oslc:shortTitle may be used instead of dcterms:title in presentations where visual space is severely limited.

Clients should not fetch Compact representations when there is perfectly usable default display information available. When designing a Client application, consideration should be given to the potential benefits of obtaining an improved title and icon for the target resource against the costs of preemptively fetching the Compact representation in terms of added load on servers and networks (which might only be apparent to users on slow networks or heavily loaded servers).

Clients should be wary of material obtained from non-trusted sources; in particular, the Client should check that the dcterms:title and oslc:shortTitle property values do not contain HTML markup beyond the specified set of simple elements.

4.4 Preview sizing

This section is non-normative.

When the resource does not supply preferred sizing for a preview, the Client should default to a reasonably generous value. The default value a Client uses may be different for different window and screen sizes.

4.5 Displaying a small preview

This section is non-normative.

If a user mouses or hovers over a displayed link, the Client should determine whether the target resource has a small preview (oslc:smallPreview). If it does, the Client should present the small preview document in a hovering widget. Since preview documents may contain arbitrary content, including HTML and scripts, Client must use iframes if embedding the preview document inside another HTML-based presentation.

The Client should not attempt to prefetch a Compact representation just to have the preview URIs in hand so that the hover can come up faster. There is a low chance that the user will make a gesture that would call for the display of a small preview. It would generally be a poor trade-off to increase overall system load just to decrease UI latency for low probability eventualities. Clients may wish to utilize lazy loading techniques to only access preview dialogs that users actually view, and can cache those dialogs for subsequent uses if needed to improve performance.

4.6 Displaying a large preview

This section is non-normative.

If the user then gestures that they want to see a bit more of the resource, the Client should determine whether the target resource has a large preview (oslc:largePreview). If it does, the Client should present the large preview document in a stationary widget that permits further user interaction. Again, since preview documents may contain arbitrary content, including HTML and scripts, Clients must use iframes if embedding the preview document inside another HTML-based presentation.

5. Implementation Conformance

5.1 General

Servers MAY choose to provide Compact resources for some resources and not others. [RP-1]

Resources with previews MUST support the HTTP OPTIONS method. [RP-2]

In responses to HTTP GET requests targeting resources that have a Compact resource, servers SHOULD either include a Vary response header with at least Accept and Prefer field values or a Cache-Control header value no-store. [RP-3]

Servers MAY consult the Accept-Language header on requests for a Compact resource (and on requests for preview documents) to return a resource for the requested natural language. [RP-4]

Clients SHOULD gracefully handle unsuccessful attempts to use previews. Previews may not be supported for all resources or may not work due to security or service availability issues. [RP-5]

5.2 Accept Header

In response to OPTIONS, HEAD or GET on resource, servers MAY include an Accept: application/x-oslc-compact+xml header to indicate the resource provides a compact representation. [RP-6]

Servers MAY support the application/x-oslc-compact+xml MIME type extension to allow clients to use content negotiation to access the Compact resource. However, this usage should be considered deprecated and is only provided for OSLC 2.0 compatibility. [RP-7]

Servers that do support the application/x-oslc-compact+xml MIME type extension MUST return the Compact resource using Content-Type: application/x-oslc-compact+xml as specified in [OSLCUIPreview20]. [RP-8]

5.4 Prefer Headers

Clients MAY request that the Compact resource is returned inline with the target resource using the Prefer request header [RFC7240] and

  • Preference return, value representation
  • Parameter include [LDP], value http://open-services.net/ns/core#PreferCompact.
[RP-11]
Example 16: Example Prefer Header
Prefer: return=representation; include="http://open-services.net/ns/core#PreferCompact"

Servers MUST honor a client's request to in-line the Compact resource in JSON and RDF representations if the target resource has a Compact resource and the request is successful. [RP-12]

If the target resource does not exist or is not accessible to the requesting client, servers MUST return the same status code that it would have returned had the client not included the Prefer header in the request. [RP-13]

When servers in-line the Compact resource with the target resource in an application/json [RFC4627] response, the response entity MUST be a JSON object with a compact property where the value is the Compact resource JSON as described in Appendix A. JSON Representation Format. [RP-14]

Servers MAY choose to return only a subset of the target resource properties when a client requests that the Compact resource is returned in-line. [RP-15]

Clients SHOULD inspect the response body for the Compact resource even if the server omits the Preference-Applied header [RFC7240]. [RP-16]

5.5 Compact Resources

Servers MUST support the application/json [RFC4627] and text/turtle [turtle] media types for the Compact resource. [RP-17]

Servers SHOULD support the application/ld+json media type [JSON-LD] for the Compact resource. [RP-18]

The application/json Compact resource representation MUST be in the JSON format described in Appendix A. JSON Representation Format. [RP-19]

Servers MAY respond with JSON-LD in compacted document form when clients request the application/json representation of the Compact resource as long as the response meets the requirements for the JSON representation. [RP-20]

RDF representations of the Compact resource MUST conform to the shape specified in 6.1 Resource: Compact. [RP-21]

Content-Type application/x-oslc-compact+xml representations of the Compact resource MUST conform to the shape specified in XML Representation Format. [RP-22]

The Compact resource MAY have additional server-specific properties. [RP-23]

5.6 Previews

When displaying a preview inside another HTML presentation, clients MUST use an iframe element, setting its src attribute to the preview's document URI. [RP-24]

Servers MUST express the oslc:hintWidth and oslc:hintHeight properties of an oslc:Preview in length units as specified in [CSS21]. [RP-25]

Servers MAY use dynamic resizing for small and large previews in addition to oslc:Preview oslc:hintHeight and oslc:hintWidth properties. [RP-26]

Servers that support dynamic sizing MUST send resize messages to the parent window using the Window.postMessage method [webmessaging] where the source of the event is the preview's window. [RP-27]

A resize message MUST consist of the characters oslc-resize: followed by a JSON object with at least one of the following properties:

  • oslc:hintHeight or
  • oslc:hintWidth.
[RP-28]
Example 17: Example Resize Message
oslc-resize:{"oslc:hintHeight": "277px", "oslc:hintWidth": "400px"}

A resize message MAY also also consist of the characters oslc-preview-height: followed by the desired height in pixels. [RP-29]

Example 18: Example Resize Height Message
oslc-preview-height:277

This postMessage format should be considered deprecated and is only provided for OSLC 2.0 compatibility.

The oslc:hintHeight and oslc:hintWidth property values in the resize message JSON MUST be length units as specified in [CSS21]. [RP-30]

Servers MAY send more than one dynamic resize request. [RP-31]

Clients MAY choose to ignore the size hints in oslc:Preview resources or in dynamic resize messages. [RP-32]

6. Resource Constraints

This document applies the following constraints to the OSLC Core vocabulary terms.

An OSLC server providing the Resource Preview capability MUST implement the vocabulary defined in this section. [RP-33]

6.1 Resource: Compact

Compact Properties
Prefixed Name Occurs Read-only Value-type Representation Range Description
dcterms:title Zero-or-one true string N/A Unspecified Title that may be used in the display of a link to the resource. The value should include only content that is valid inside an HTML <span> element. Providers should include a dcterms:title property with an informative label for the resource. The title is typically shown to a user as a hyperlink. For a resource with no obvious title, Providers should omit the dcterms:title property. Providers must first HTML escape the contents of the dcterms:title before sending the response.
oslc:icon Zero-or-one true Resource Reference Unspecified URI of an image which may be used in the display of a link to the resource.
oslc:iconAltLabel Zero-or-one true string N/A Unspecified Alternative label used in association with the oslc:icon, such as HTML img tag's alt attribute.
oslc:iconSrcSet Zero-or-one true string N/A Unspecified Specification of a set of images of different sizes based on HTML img element srcset attribute.
oslc:iconTitle Zero-or-one true string N/A Unspecified Title used in association with the oslc:icon, such as HTML img tag's title attribute.
oslc:largePreview Zero-or-one true AnyResource Either oslc:Preview URI and sizing properties for an HTML document to be used for a large preview.
oslc:shortTitle Zero-or-one true string N/A Unspecified Abbreviated title which may be used in the display of a link to the resource. The value should include only content that is valid inside an HTML <span> element. Providers should include an abbreviated title for the resource when possible. The abbreviated title is typically shown to a user as a hyperlink in presentations where visual space is limited. As a general guideline, the length of the abbreviated title should be 5 characters or less. A user-visible identifier that ordinarily appears in the dcterms:title, such as a defect number, makes for a good oslc:shortTitle value. When a resource has no obvious identifier or handle, Providers should omit the oslc:shortTitle property. Providers must first HTML escape the contents of the oslc:shortTitle before sending the response.
oslc:smallPreview Zero-or-one true AnyResource Either oslc:Preview URI and sizing properties for an HTML document to be used for a small preview.

6.2 Resource: Preview

Preview Properties
Prefixed Name Occurs Read-only Value-type Representation Range Description
oslc:document Exactly-one true Resource Reference Unspecified The URI of an HTML document to be used for the preview.
oslc:hintHeight Zero-or-one true string N/A Unspecified Recommended height of the preview. Values are expressed using length units as specified in [CSS21].
oslc:hintWidth Zero-or-one true string N/A Unspecified Recommended width of the preview. Values are expressed using length units as specified in [CSS21].

7. Conformance

Implementations of this specification need to satisfy the following conformance clauses.

Clause Number Requirement
RP-1 Servers MAY choose to provide Compact resources for some resources and not others.
RP-2 Resources with previews MUST support the HTTP OPTIONS method.
RP-3 In responses to HTTP GET requests targeting resources that have a Compact resource, servers SHOULD either include a Vary response header with at least Accept and Prefer field values or a Cache-Control header value no-store.
RP-4 Servers MAY consult the Accept-Language header on requests for a Compact resource (and on requests for preview documents) to return a resource for the requested natural language.
RP-5 Clients SHOULD gracefully handle unsuccessful attempts to use previews. Previews may not be supported for all resources or may not work due to security or service availability issues.
RP-6 In response to OPTIONS, HEAD or GET on resource, servers MAY include an Accept: application/x-oslc-compact+xml header to indicate the resource provides a compact representation.
RP-7 Servers MAY support the application/x-oslc-compact+xml MIME type extension to allow clients to use content negotiation to access the Compact resource. However, this usage should be considered deprecated and is only provided for OSLC 2.0 compatibility.
RP-8 Servers that do support the application/x-oslc-compact+xml MIME type extension MUST return the Compact resource using Content-Type: application/x-oslc-compact+xml as specified in [OSLCUIPreview20].
RP-9

In responses to successful HTTP requests for a target resource that has a Compact resource, servers MUST include a Link header [RFC5988] where:

  • The context URI is the effective request URI,
  • The link relation is http://open-services.net/ns/core#Compact, and
  • The target URI is the URI of the Compact resource.
RP-10

If a newly-created resource has a Compact resource, servers MAY return a Link header in response to the creation request where:

  • The context URI is the URI of the newly-created resource,
  • The link relation is http://open-services.net/ns/core#Compact, and
  • The target URI is the URI of the associated Compact resource.
RP-11

Clients MAY request that the Compact resource is returned inline with the target resource using the Prefer request header [RFC7240] and

  • Preference return, value representation
  • Parameter include [LDP], value http://open-services.net/ns/core#PreferCompact.
RP-12 Servers MUST honor a client's request to in-line the Compact resource in JSON and RDF representations if the target resource has a Compact resource and the request is successful.
RP-13 If the target resource does not exist or is not accessible to the requesting client, servers MUST return the same status code that it would have returned had the client not included the Prefer header in the request.
RP-14 When servers in-line the Compact resource with the target resource in an application/json [RFC4627] response, the response entity MUST be a JSON object with a compact property where the value is the Compact resource JSON as described in Appendix A. JSON Representation Format.
RP-15 Servers MAY choose to return only a subset of the target resource properties when a client requests that the Compact resource is returned in-line.
RP-16 Clients SHOULD inspect the response body for the Compact resource even if the server omits the Preference-Applied header [RFC7240].
RP-17 Servers MUST support the application/json [RFC4627] and text/turtle [turtle] media types for the Compact resource.
RP-18 Servers SHOULD support the application/ld+json media type [JSON-LD] for the Compact resource.
RP-19 The application/json Compact resource representation MUST be in the JSON format described in Appendix A. JSON Representation Format.
RP-20 Servers MAY respond with JSON-LD in compacted document form when clients request the application/json representation of the Compact resource as long as the response meets the requirements for the JSON representation.
RP-21 RDF representations of the Compact resource MUST conform to the shape specified in 6.1 Resource: Compact.
RP-22 Content-Type application/x-oslc-compact+xml representations of the Compact resource MUST conform to the shape specified in XML Representation Format.
RP-23 The Compact resource MAY have additional server-specific properties.
RP-24 When displaying a preview inside another HTML presentation, clients MUST use an iframe element, setting its src attribute to the preview's document URI.
RP-25 Servers MUST express the oslc:hintWidth and oslc:hintHeight properties of an oslc:Preview in length units as specified in [CSS21].
RP-26 Servers MAY use dynamic resizing for small and large previews in addition to oslc:Preview oslc:hintHeight and oslc:hintWidth properties.
RP-28

A resize message MUST consist of the characters oslc-resize: followed by a JSON object with at least one of the following properties:

  • oslc:hintHeight or
  • oslc:hintWidth.
RP-29 A resize message MAY also also consist of the characters oslc-preview-height: followed by the desired height in pixels.
RP-30 The oslc:hintHeight and oslc:hintWidth property values in the resize message JSON MUST be length units as specified in [CSS21].
RP-31 Servers MAY send more than one dynamic resize request.
RP-32 Clients MAY choose to ignore the size hints in oslc:Preview resources or in dynamic resize messages.
RP-33 An OSLC server providing the Resource Preview capability MUST implement the vocabulary defined in this section.

Appendix A. JSON Representation Format

A Compact resource JSON representation might look like the following for the target resource http://example.com/bugs/324:

Example 19: Compact Resource JSON
{
    "title": "324: Need a fix <em>NOW</em>",
    "shortTitle": "324",
    "icon": "http://example.com/icons/defect.jpg",
    "iconSrcSet": "http://example.com/icons/smallIcon.png 16w, http://example.com/icons/largeIcon.png 64w",
    "iconTitle": "Defect",
    "iconAltLabel": "Defect",
    "largePreview": {
        "document": "http://example.com/bugs/324?preview=large",
        "hintHeight": "250px",
        "hintWidth": "400px"
    },
    "smallPreview": {
        "document": "http://example.com/bugs/324?preview=small"
    }
}

The JSON representation has the following constraints:

A.1 JSON-LD Context

This section is non-normative.

The following JSON-LD Context may be used with JSON Compact representations.

Example 20: JSON-LD Context for a Compact Resource
{
    "_comment": "JSON-LD context for OSLC Resource Preview",
    "@context": {
        "@base": "@https://tools.oasis-open.org/version-control/svn/oslc-core/trunk/specs/contexts/preview.jsonld",
        "oslc" : "http://open-services.net/ns/core#",
        "rdf" : "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
        "dcterms" : "http://purl.org/dc/terms/",
        "@vocab": "http://open-services.net/ns/core#",

        "dcterms:title": {
            "@id": "dcterms:title",
            "@type": "xsd:string"
        },
        "compact": {
            "@id": "oslc:compact",
            "@type": "@id"
        },
        "icon": {
            "@id": "oslc:icon",
            "@type": "@id"
        },
        "iconSrcSet": {
            "@id": "oslc:iconSrcSet",
            "@type": "@id"
        },
        "iconAltLabel": {
            "@id": "oslc:iconAltLabel",
            "@type": "xsd:string"
        },
        "hintHeight": {
            "@id": "oslc:hintHeight",
            "@type": "xsd:integer"
        },
        "hintWidth": {
            "@id": "oslc:hintWidth",
            "@type": "xsd:integer"
        },
        "shortTitle": {
            "@id": "oslc:iconTitle",
            "@type": "xsd:string"
        },
        "smallPreview": {
            "@id": "oslc:smallPreview",
            "@type": "oslc:Preview"
        },
        "largePreview": {
            "@id": "oslc:largePreview",
            "@type": "oslc:Preview"
        }
    }
}

A.2 JSON Schema

This section is non-normative.

The following JSON Schema [JSONSchema] describes the Compact JSON representation.

Example 21: JSON Schema for a Compact Resource
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "OSLC 3.0 Compact JSON",
    "type": "object",
    "properties": {
        "title": {
            "id": "title",
            "type": "string"
        },
        "shortTitle": {
            "id": "shortTitle",
            "type": "string"
        },
        "icon": {
            "id": "icon",
            "type": "string"
        },
        "iconTitle": {
            "id": "iconTitle",
            "type": "string"
        },
        "iconAltLabel": {
            "id": "iconAltLabel",
            "type": "string"
        },
        "largePreview": {
            "id": "largePreview",
            "type": "object",
            "properties": {
                "document": {
                    "id": "document",
                    "type": "string"
                },
                "hintHeight": {
                    "id": "hintHeight",
                    "type": "string",
                    "pattern": "^[0-9]+(\\.[0-9]+)?(em|ex|in|cm|mm|pt|pc|px)$"
                },
                "hintWidth": {
                    "id": "hintWidth",
                    "type": "string",
                    "pattern": "^[0-9]+(\\.[0-9]+)?(em|ex|in|cm|mm|pt|pc|px)$"
                }
            },
            "required": [
                "document"
            ]
        },
        "smallPreview": {
            "id": "smallPreview",
            "type": "object",
            "properties": {
                "document": {
                    "id": "document",
                    "type": "string"
                },
                "hintHeight": {
                    "id": "hintHeight",
                    "type": "string",
                    "pattern": "^[0-9]+(\\.[0-9]+)?(em|ex|in|cm|mm|pt|pc|px)$"
                },
                "hintWidth": {
                    "id": "hintWidth",
                    "type": "string",
                    "pattern": "^[0-9]+(\\.[0-9]+)?(em|ex|in|cm|mm|pt|pc|px)$"
                }
            },
            "required": [
                "document"
            ]
        }
    }
}

Appendix B. XML Representation Format

A Compact resource XML representation woould look like the following for the target resource http://example.com/bugs/12345:

Example 22: Compact Resource XML
<?xml version="1.0" encoding="UTF-8"?>

<rdf:RDF
   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
   xmlns:dcterms="http://purl.org/dc/terms/"
   xmlns:oslc="http://open-services.net/ns/core#">

 <oslc:Compact
   rdf:about="http://example.com/bugs/12345">

   <dcterms:title> 12345: Need a &quot;fix&quot; &lt;em&gt;NOW&lt;/em&gt; </dcterms:title>
   <oslc:shortTitle> 12345 </oslc:shortTitle>
   <oslc:icon rdf:resource="http://example.com/icons/defect.jpg" />
   <oslc:iconAltLabel>Defect</oslc:iconAltLabel>
   <oslc:iconTitle>Defect</oslc:iconTitle>

   <oslc:smallPreview>
      <oslc:Preview>
         <oslc:document rdf:resource="http://example.com/bugs/12345?hover=small" />
      </oslc:Preview>
   </oslc:smallPreview>


   <oslc:largePreview>
      <oslc:Preview>
         <oslc:document rdf:resource="http://example.com/bugs/12345?hover=large" />
         <oslc:hintWidth> 60em </oslc:hintWidth>
         <oslc:hintHeight> 20em </oslc:hintHeight>
      </oslc:Preview>
   </oslc:largePreview>

 </oslc:Compact>

</rdf:RDF>

The XML representation has the following syntactic and semantic constraints:

Appendix C. Change History

This section is non-normative.

Revision Date Editor Changes Made
01 04 April 2017 Jim Amsden CS was approved and published.
03 31 May 2018 Jim Amsden Added XML compact resource representation from OSLC Core 2.0.
04 26 June 2019 Jim Amsden Added conformance section and migrated to Open Project