Network Working Group M. Amundsen
Internet-Draft August 10, 2011
Expires: February 11, 2012
The Item and Collection Link Relations
draft-amundsen-item-and-collection-link-relations-00
Abstract
RFC 5988 [RFC5988] defined the way of indicating resources on the
Web. This specification defines a pair of reciprocal link relation
types that may be used to express the relationship between a
collection and its members.
Editorial Note (To be removed by RFC Editor)
Distribution of this document is unlimited. Comments should be sent
to the IETF Link-Relations mailing list (see
<https://www.ietf.org/mailman/listinfo/link-relations>).
Status of This Memo
This Internet-Draft is submitted to IETF in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that
other groups may also distribute working documents as Internet-
Drafts.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt.
The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html.
This Internet-Draft will expire on February 11, 2012.
Copyright Notice
Copyright (c) 2011 IETF Trust and the persons identified as the
document authors. All rights reserved.
Amundsen Expires February 11, 2012 [Page 1]
Internet-Draft The Item and Collection Link Relations August 2011
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the BSD License.
1. Introduction
RFC 5988 [RFC5988] defined the way of indicating resources on the
Web. This specification defines a pair of reciprocal link relation
types that may be used to express the relationship between a
collection and its members.
These link relation types can be applied to a wide range of use cases
across multiple media types. For example, the 'collection' and
'item' link relation types are used in these media types:
1. OpenSearch 1.1: see <http://www.opensearch.org/Specifications/
OpenSearch/1.1#Url_rel_values>
2. Maze+XML: see
<http://amundsen.com/media-types/maze/format/#link-relations>
3. Collection+JSON: see <http://amundsen.com/media-types/collection/
format/#link-relations>
2. Link Relations
The following link relations are defined.
2.1. 'item'
When included in a resource which represents a collection, the 'item'
link relation identifies a target resource that represents a member
of that collection.
For example, if a resource represents a catalog of products, that
same representation may include one or more links to resources which
represent members of that catalog.
Amundsen Expires February 11, 2012 [Page 2]
Internet-Draft The Item and Collection Link Relations August 2011
<html>
...
<h1>Product Group X Listing</h1>
...
<a href="..." rel="item">View Product X001</a>
<a href="..." rel="item">View Product X002</a>
...
</html>
or
Link: <...>; rel="item"; title="View Product X001"
Link: <...>; rel="item"; title="View Product X002"
2.2. 'collection'
When included in a resource which represents a member of a
collection, the 'collection' link relation identifies a target
resource that represents a collection of which the context resource
is a member.
For example, if a resource represents a single product in a catalog,
that same representation may include a link to a resource which
represents a product group to which this single product belongs:
<a href="..." rel="collection">Return to Product Group X</a>
or
Link: <...>; rel="collection"; title="Return to Product Group X"
Since it is possible that a resource could be a member of multiple
collections, multiple 'collection' link relations may appear within
the same representation:
<a href="..." rel="collection">View other widgets</a>
<a href="..." rel="collection">View all discontinued items</a>
The target resource representation need not be restricted to
representing a list. It may simply be a document that provides
details on the collection of which the context resource is a member:
Link: <...>; rel="collection";
title="Shakespeare's Collected Works - A History"
Amundsen Expires February 11, 2012 [Page 3]
Internet-Draft The Item and Collection Link Relations August 2011
3. IANA Considerations
IANA is asked to register the 'collection' and 'item' Link Relations
below as per [RFC5988].
3.1. 'item' Link Relation Registration
Relation Name:
item
Description:
The target IRI points to a resource that is a member of the
collection represented by the context IRI.
Reference:
See Section 2
Notes:
None.
Application Data:
None.
3.2. 'collection' Link Relation Registration
Relation Name:
collection
Description:
The target IRI points to a resource which represents a collection
of which the context IRI is a member.
Reference:
See Section 2
Notes:
None.
Application Data:
Amundsen Expires February 11, 2012 [Page 4]
Internet-Draft The Item and Collection Link Relations August 2011
None.
4. Security Considerations
See Section 7 of RFC5988 [RFC5988].
5. Internationalisation Considerations
See Section 8 of RFC5988 [RFC5988].
6. Normative References
[RFC5988] Nottingham, M., "Web Linking", RFC 5988, October 2010.
Author's Address
Mike Amundsen
EMail: mca@amundsen.com
URI: http://amundsen.com
Amundsen Expires February 11, 2012 [Page 5]
