Skip to content

Commit a4ca849

Browse files
gkellogggkellogg
committed
Adds a preliminary IANA section with placeholders.
Fixes #14. Fixes #25.
1 parent 38617ce commit a4ca849

File tree

1 file changed

+154
-3
lines changed

1 file changed

+154
-3
lines changed

‎spec/index.html

Lines changed: 154 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
}],
1818

1919
// Cross-reference definitions
20-
xref: ["json-ld11", "json-ld11-api", "json-ld11-framing"],
20+
//xref: ["json-ld11", "json-ld11-api", "json-ld11-framing"],
2121

2222
group: "cg/json-ld",
2323
wgPublicList: "public-linked-json",
@@ -215,6 +215,7 @@ <h2>Introduction</h2>
215215

216216
<section id="conformance">
217217
<p>A <a>YAML-LD document</a> complies with this specification if ...</p>
218+
<p class="ednote">Define <dfn>YAML-LD document</dfn> somewhere.</p>
218219

219220
<p>This specification makes use of the following namespace prefixes:</p>
220221
<table class="simple">
@@ -238,8 +239,8 @@ <h2>Introduction</h2>
238239
</tbody>
239240
</table>
240241

241-
<p>These are used within this document as part of a <a>compact IRI</a>
242-
as a shorthand for the resulting <a>IRI</a>, such as <code>dcterms:title</code>
242+
<p>These are used within this document as part of a <a data-cite="JSON-LD11#dfn-compact-iri">compact IRI</a>
243+
as a shorthand for the resulting <a data-cite="rfc3987#section-2">IRI</a>, such as <code>dcterms:title</code>
243244
used to represent <code>http://purl.org/dc/terms/title</code>.</p>
244245
</section>
245246

@@ -248,5 +249,155 @@ <h2>Basic Concepts</h2>
248249

249250
<p>FIXME.</p>
250251
</section>
252+
253+
<section class="appendix normative">
254+
<h2>IANA Considerations</h2>
255+
256+
<p>This section has been submitted to the Internet Engineering Steering
257+
Group (IESG) for review, approval, and registration with IANA.</p>
258+
259+
<h3>application/ld+json</h3>
260+
<dl>
261+
<dt>Type name:</dt>
262+
<dd>application</dd>
263+
<dt>Subtype name:</dt>
264+
<dd>ld+yaml</dd>
265+
<dt>Required parameters:</dt>
266+
<dd>N/A</dd>
267+
<dt>Optional parameters:</dt>
268+
<dd>
269+
<dl>
270+
<dt><code>profile</code></dt>
271+
<dd>
272+
<p>A non-empty list of space-separated URIs identifying specific
273+
constraints or conventions that apply to a YAML-LD document according to [[RFC6906]].
274+
A profile does not change the semantics of the resource representation
275+
when processed without profile knowledge, so that clients both with
276+
and without knowledge of a profiled resource can safely use the same
277+
representation. The <code>profile</code> parameter MAY be used by
278+
clients to express their preferences in the content negotiation process.
279+
If the profile parameter is given, a server SHOULD return a document that
280+
honors the profiles in the list which it recognizes,
281+
and MUST ignore the profiles in the list which it does not recognize.
282+
It is RECOMMENDED that profile URIs are dereferenceable and provide
283+
useful documentation at that URI. For more information and background
284+
please refer to [[RFC6906]].</p>
285+
<p>This specification defines seven values for the <code>profile</code> parameter.</p>
286+
<dl>
287+
<dt><code>http://www.w3.org/ns/json-ld#expanded</code></dt>
288+
<dd>To request or specify <a data-cite="json-ld11#dfn-expanded-document-form">expanded YAML-LD document form</a>.</dd>
289+
<dt><code>http://www.w3.org/ns/json-ld#compacted</code></dt>
290+
<dd>To request or specify <a data-cite="json-ld11#dfn-compacted-document-form">compacted YAML-LD document form</a>.</dd>
291+
<dt><code>http://www.w3.org/ns/json-ld#context</code></dt>
292+
<dd>To request or specify a <a data-cite="json-ld11#dfn-context-document">YAML-LD context document</a>.</dd>
293+
<dt><code>http://www.w3.org/ns/json-ld#flattened</code></dt>
294+
<dd>To request or specify <a data-cite="json-ld11#dfn-flattened-document-form">flattened YAML-LD document form</a>.</dd>
295+
<dt><code>http://www.w3.org/ns/json-ld#frame</code></dt>
296+
<dd>To request or specify a <a data-cite="json-ld11-framing#dfn-frame">YAML-LD frame document</a>.</dd>
297+
<dt><code>http://www.w3.org/ns/json-ld#framed</code></dt>
298+
<dd>To request or specify <a data-cite="json-ld11#dfn-framed-document-form">framed YAML-LD document form</a>.</dd>
299+
<dt><code>http://www.w3.org/ns/json-ld#extended</code></dt>
300+
<dd>To request or specify <a data-lt="extended document form">extended YAML-LD document form</a>.
301+
<div class="ednote">
302+
This is a placeholder for specifying something like an
303+
<dfn data-lt="extended-document-form">extended YAML-LD document form</dfn>
304+
making use of YAML-specific features.
305+
</div></dd>
306+
</dl>
307+
<p>All other URIs starting with <code>http://www.w3.org/ns/json-ld</code>
308+
are reserved for future use by JSON-LD specifications.</p>
309+
<!--p>Other specifications MAY create further structured subtypes
310+
by using `+ld+json` as a suffix for a new base subtype, as in
311+
`application/example+ld+json`.
312+
Unless defined otherwise, such subtypes use the same
313+
fragment identifier behavior as `application/ld+json`.</p-->
314+
<p>Other specifications may publish additional `profile` parameter
315+
URIs with their own defined semantics.
316+
This includes the ability to associate a file extension with a `profile` parameter.</p>
317+
<p>
318+
When used as a <a data-cite="RFC4288#section-4.3">media type parameter</a> [[RFC4288]]
319+
in an <a data-cite="rfc7231#rfc.section.5.3.2">HTTP Accept header</a> [[RFC7231]],
320+
the value of the <code>profile</code> parameter MUST be enclosed in quotes (<code>"</code>) if it contains
321+
special characters such as whitespace, which is required when multiple profile URIs are combined.</p>
322+
<p>When processing the "profile" media type parameter, it is important to
323+
note that its value contains one or more URIs and not IRIs. In some cases
324+
it might therefore be necessary to convert between IRIs and URIs as specified in
325+
<a data-cite="RFC3986#section-5.1">section 3 Relationship between IRIs and URIs</a>
326+
of [[RFC3987]].</p>
327+
</dd>
328+
</dl>
329+
</dd>
330+
<dt>Encoding considerations:</dt>
331+
<dd>See <a data-cite="RFC8259#section-11">RFC&nbsp;8259, section 11</a>.</dd>
332+
<dt id="iana-security">Security considerations:</dt>
333+
<dd>See <a data-cite="RFC8259#section-12">RFC&nbsp;8259, section 12</a> [[RFC8259]]
334+
<p>When processing YAML-LD documents, links to remote contexts and frames are
335+
typically followed automatically, resulting in the transfer of files
336+
without the explicit request of the user for each one. If remote
337+
contexts are served by third parties, it may allow them to gather
338+
usage patterns or similar information leading to privacy concerns.
339+
Specific implementations, such as the API defined in the
340+
JSON-LD 1.1 Processing Algorithms and API specification [[JSON-LD11-API]],
341+
may provide fine-grained mechanisms to control this behavior.</p>
342+
<p>YAML-LD contexts that are loaded from the Web over non-secure connections,
343+
such as HTTP, run the risk of being altered by an attacker such that
344+
they may modify the YAML-LD <a data-cite="json-ld11#dfn-active-context">active context</a> in a way that
345+
could compromise security. It is advised that any application that
346+
depends on a remote context for mission critical purposes vet and
347+
cache the remote context before allowing the system to use it.</p>
348+
<p>Given that YAML-LD allows the substitution of long IRIs with short terms,
349+
YAML-LD documents may expand considerably when processed and, in the worst case,
350+
the resulting data might consume all of the recipient's resources. Applications
351+
should treat any data with due skepticism.</p>
352+
<p>As YAML-LD places no limits on the IRI schemes that may be used,
353+
and vocabulary-relative IRIs use string concatenation rather than
354+
IRI resolution, it is possible to construct IRIs that may be
355+
used maliciously, if dereferenced.</p>
356+
</dd>
357+
<dt>Interoperability considerations:</dt>
358+
<dd>Not Applicable</dd>
359+
<dt>Published specification:</dt>
360+
<dd>http://www.w3.org/TR/yaml-ld</dd>
361+
<dt>Applications that use this media type:</dt>
362+
<dd>Any programming environment that requires the exchange of
363+
directed graphs. Implementations of YAML-LD have been created for
364+
<span class="note">FIXME</span>.
365+
</dd>
366+
<dt>Additional information:</dt>
367+
<dd>
368+
<dl>
369+
<dt>Magic number(s):</dt>
370+
<dd>Not Applicable</dd>
371+
<dt>File extension(s):</dt>
372+
<dd>.yamlld</dd>
373+
<dt>Macintosh file type code(s):</dt>
374+
<dd>TEXT</dd>
375+
</dl>
376+
</dd>
377+
<dt>Person &amp; email address to contact for further information:</dt>
378+
<dd>Philippe Le Hégaret &lt;[email protected]&gt;</dd>
379+
<dt>Intended usage:</dt>
380+
<dd>Common</dd>
381+
<dt>Restrictions on usage:</dt>
382+
<dd>N/A</dd>
383+
<dt>Author(s):</dt>
384+
<dd>...</dd>
385+
<dt>Change controller:</dt>
386+
<dd>W3C</dd>
387+
</dl>
388+
389+
<p>Fragment identifiers used with <a href="#application-ld-json">application/yaml+json</a>
390+
are treated as in RDF syntaxes, as per
391+
<a data-cite="RDF11-CONCEPTS#section-fragID">RDF 1.1 Concepts and Abstract Syntax</a>
392+
[[RDF11-CONCEPTS]].
393+
<div class="ednote">Perhaps more on fragment identifiers from <span class="issue" data-number="13"></span></div>
394+
</p>
395+
396+
<section id="iana-examples" class="informative">
397+
<h3>Examples</h3>
398+
<p class="ednote">FIXME</p>
399+
</section>
400+
</section>
401+
251402
</body>
252403
</html>

0 commit comments

Comments
 (0)