[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: Re: [oslc-core] Review comments for OLSC Resource Preview 3.0
Example 5: Requesting the Compact Resource
GET /bugs/324/screenshot?compact HTTP/1.1
Host: example.com
Accept: application/json
Does this guarantee a JSON response?
What other media types MUST or MAY be supported by the server?
If "application/rdf+xml" is permitted, how does this differ from
the XML response format that says it should be be processed as RDF/XML?
<jra>OSLC (and LDP)
require support for Turtle and JSON-LD - that's specified in the OSLC overview
document. So application/json would guarantee a JSON response. If
application/rdf+xml is specified, then the response body would need to
be RDF/XML. For OSLC2, the Accept header would be application/xml or text/xml.</jra>
5.1.3 Discovering Compact Resources Using the HTTP Prefer Header
Clients can request a Compact resource by making an HTTP GET request to
the target resource's URI using the return=representationpreference 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.
Does Accept=application/json guarantee a JSON response?
Should "must" be "MUST"?
What other media types MUST or MAY be supported by the server?
<jra>Same as above,
Accept: application/json will return JSON. Must is ok since this section
is non-normative. LDP specifies Turtle and JSON-LD as does OSLC3. The representation
formations are described in oslc-core.html.</jra>
6.5 Displaying a small preview
6.6 Displaying a large preview
Is there a way that a client can request small vs large preview?
Or is the expected behaviour that servers return both small and large preview
data in the same response and the client can choose which to display?
Should a client preserve the ordering of data in the response (for JSON)?
If so, what about Turtle where ordering may not be preserved?
<jra>The client always
requests the preview it desires using either the oslc:smallPreview or oslc:largePreview
property of the Compact resource. Servers only return the specifically
requested preview. The Compact resource does not contain default preview
dialogs. There is no need to preserve the order of the data in the Compact
resource, the properties are not in a collection that could be ordered.
The small and large preview are HTML dialogs, not Turtle or JSON.</jra>
7.5 Compact Resources
7.5.1 Servers MUST support the application/json[RFC4627]
and text/turtle[turtle]
media types for the Compact resource.
Shouldn't this also include application/x-oslc-compact+xml?
<jra>No, since that's
deprecated. They would support application/x-oslc-compact+xml if they need
to be OSLC2 compatibile, but we don't require that, we only define how
it can be accomplished if desired.</jra>
A. Resource Constraints
A.1 Resource: Compact
B. JSON Representation Format
The table in A.1 shows the RDF predicate prefixed name. However, the JSON
format in B seems to use an unqualified name, and I could not see anything
that said the JSON property names should match them, or reference some
other table where they are defined. Would it be clearer to have the JSON
section simply reference the table in A.1 with some statement about the
JSON property name? Currently the data seems duplicated between the two,
with the danger they might get out of sync with each other.
Unless stated otherwise above:
IBM United Kingdom Limited - Registered in England and Wales with number
741598.
Registered office: PO Box 41, North Harbour, Portsmouth, Hampshire PO6
3AU
<jra>The JSON representation in Appendix B is predefined JSON, not RDF or JSON-LD. The format is defined by the constraints following the example. Its intended to be an easily consumable format when RDF is not needed. If you add the JSON-LD context in appendes B.1 to the JSON in B, you'll get the fully qualified names and something that carries the full RDF representation.</jra>
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]