Atom Link Relations

Last Updated
2009-01-26

This registry is also available in XML and plain text formats.

Registry included below

Atom Link Relations

Reference
[RFC4287]
Registration Procedures
IESG Approval (via request to IANA)
Value Description Expected Display Characteristics Security Considerations Reference Registration Date (if applicable)
alternate [RFC4287]
current A URI that, when dereferenced, returns a feed document containing the most recent entries in the feed. Undefined; this relation can be used for background processing or to provide extended functionality without displaying its value. Automated agents should take care when this relation crosses administrative domains (e.g., the URI has a different authority than the current document). [RFC5005] 2006-02-02
describedby The relationship A 'describedby' B asserts that resource B provides a description of resource A. There are no constraints on the format or representation of either A or B, neither are there any further constraints on either resource. None Descriptions of resources may be socially sensitive, may require processing to be understood and may or may not not be accurate. Consumers of descriptive resources should be aware of the source and chain of custody of the data. Security considerations for URIs (Section 7 of RFC 3986) and IRIs (Section 8 of RFC 3987 ) apply to the extent that describing resources may affect consumers' decisions about how or whether to retrieve those resources. [Phil_Archer][http://www.w3.org/TR/powder-dr/#assoc-linking] 2009-02-20
edit An IRI of an editable Member Entry. When appearing within an atom:entry, the href IRI can be used to retrieve, update and delete the Resource represented by that Entry. Undefined; this relation can be used for background processing or to provide extended functionality without displaying its value. Automated agents should take care when this relation crosses administrative domains (e.g., the URI has a different authority than the current document). [RFC5023] 2007-07-27
edit-media An IRI of an editable Media Resource. When appearing within an atom:entry, the href IRI can be used to retrieve, update and delete the Media Resource associated with that Entry. Undefined; this relation can be used for background processing or to provide extended functionality without displaying its value. Automated agents should take care when this relation crosses administrative domains (e.g., the URI has a different authority than the current document). [RFC5023] 2007-07-27
enclosure [RFC4287]
first A URI that refers to the furthest preceding document in a series of documents. Undefined; this relation can be used for background processing or to provide extended functionality without displaying its value. Automated agents should take care when this relation crosses administrative domains (e.g., the URI has a different authority than the current document). Such agents should also take care to detect circular references. [Mark Nottingham, December 2004] 2006-02-02
hub A URI for a hub that enables registration for real-time updates to the resource [Brett_Slatkin][http://pubsubhubbub.googlecode.com] 2009-11-20
last A URI that refers to the furthest following document in a series of documents. Undefined; this relation can be used for background processing or to provide extended functionality without displaying its value. Automated agents should take care when this relation crosses administrative domains (e.g., the URI has a different authority than the current document). Such agents should also take care to detect circular references. [Mark Nottingham, December 2004] 2006-02-02
latest-version When included on a versioned resource, this link points to a resource containing the latest (e.g., current) version. The latest version is defined by the system. For linear versioning systems, this is probably the latest version by timestamp. For systems that support branching, there will be multiple latest versions, one for each branch in the version history. Some systems may allow multiple of these link relations. Undefined; this relation can be used for background processing or to provide extended functionality without displaying its value. Automated agents should take care when these relations cross administrative domains (e.g., the URI has a different authority than the current document). Such agents should also take care to detect circular references. Care should be applied when versioned resources are subject to differing access policies. In this case, exposing links may leak information even if the linked resource itself is properly secured. In particular, the syntax of the link URI/IRI could expose sensitive information (see Section 16.2 of [RFC3253] for a similar consideration in WebDAV Versioning). Note that this applies to exposing link metadata in general, not only to links related to versioning. [RFC-brown-versioning-link-relations-07]
license [RFC4946] 2007-05-14
next A URI that refers to the immediately following document in a series of documents. Undefined; this relation can be used for background processing or to provide extended functionality without displaying its value. Automated agents should take care when this relation crosses administrative domains (e.g., the URI has a different authority than the current document). Such agents should also take care to detect circular references. [RFC5005] 2006-02-02
next-archive A URI that refers to the immediately following archive document. See [RFC-nottingham-atompub-feed-history-11.txt] [RFC5005] 2007-07-13
payment rel="payment" indicates a URI where payment is accepted. It is meant as a general way to facilitate acts of payment, and thus this specification makes no assumptions on the type of payment or transaction protocol. Examples may include a WWW page where donations are accepted or where goods and services are available for purchase. rel="payment" is not intended to initiate an automated transaction. A link element with a rel="payment" attribute may exist at the feed/channel level and/or the entry/item level. For example, a rel="payment" link at the feed/channel level may point to a "tip jar" URI, whereas an entry/item containing a book review may include a rel="payment" link that points to the location where the book may be purchased through an online retailer. End-user software could support rel="payment" by displaying a "payment button" along with the content. Alternatively, content aggregators may display a payment hyperlink containing the text specified in a corresponding title attribute within the <link> element, for example: <link rel="payment" href="http://example.com/c.r.e.a.m" title="give me the loot"/> May display either a payment button or a hyperlink containing the text, "give me the loot." The link element is subject to tampering and observation, as is the linked resource. For that reason, implementations should clearly signal the level trust and privacy a linked resource provides. If present, digital signatures provide authentication, message integrity, and non-repudiation with proof of origin. Encryption provides data confidentiality. Implementations should also consider the level of confidentiality and message integrity provided by the transport used to reach the payment resource. [Joshua_Kinberg][Robert_Sayre] 2006-02-02
predecessor-version When included on a versioned resource, this link points to a resource containing the predecessor version in the version history. Some systems may allow multiple of these link relations in the case of a multiple branches merging. Undefined; this relation can be used for background processing or to provide extended functionality without displaying its value. Automated agents should take care when these relations cross administrative domains (e.g., the URI has a different authority than the current document). Such agents should also take care to detect circular references. Care should be applied when versioned resources are subject to differing access policies. In this case, exposing links may leak information even if the linked resource itself is properly secured. In particular, the syntax of the link URI/IRI could expose sensitive information (see Section 16.2 of [RFC3253] for a similar consideration in WebDAV Versioning). Note that this applies to exposing link metadata in general, not only to links related to versioning. [RFC-brown-versioning-link-relations-07]
prev-archive A URI that refers to the immediately preceding archive document. See [RFC-nottingham-atompub-feed-history-11.txt] [RFC5005] 2007-07-13
previous A URI that refers to the immediately preceding document in a series of documents. Undefined; this relation can be used for background processing or to provide extended functionality without displaying its value. Automated agents should take care when this relation crosses administrative domains (e.g., the URI has a different authority than the current document). Such agents should also take care to detect circular references. [RFC5005] 2006-02-02
related [RFC4287]
replies [RFC4685] 2006-06-28
self [RFC4287]
service rel="service" indicates a URI that can be used to retrieve an Atom Publishing Protocol Service Document as defined by RFC 5023. Support for rel="service" links will vary across user agent implementations. The link relation is intended to provide user agents with a means of auto-discovering service endpoints so that basic configuration actions can be performed automatically with minimal user input. User agents may or may not present the link to end users. The link element is subject to tampering and observation, as is the linked resource. For that reason, implementations should clearly signal the level trust and privacy a linked resource provides. If present, digital signatures provide authentication, message integrity, and non-repudiation with proof of origin. Encryption provides data confidentiality. Implementations should also consider the level of confidentiality and message integrity provided by the transport used to reach the payment resource. [James_Snell] 2008-05-20
successor-version When included on a versioned resource, this link points to a resource containing the successor version in the version history. Some systems may allow multiple of these link relations in order to support branching. Undefined; this relation can be used for background processing or to provide extended functionality without displaying its value. Automated agents should take care when these relations cross administrative domains (e.g., the URI has a different authority than the current document). Such agents should also take care to detect circular references. Care should be applied when versioned resources are subject to differing access policies. In this case, exposing links may leak information even if the linked resource itself is properly secured. In particular, the syntax of the link URI/IRI could expose sensitive information (see Section 16.2 of [RFC3253] for a similar consideration in WebDAV Versioning). Note that this applies to exposing link metadata in general, not only to links related to versioning. [RFC-brown-versioning-link-relations-07]
up A URI that refers to a parent document in a hierarchy of documents. Undefined; this relation can be used for background processing or to provide extended functionality without displaying its value. Automated agents should take care when this relation crosses administrative domains (e.g., the URI has a different authority than the current document). Such agents should also take care to detect circular references. [Noah_Slater] 2009-01-28
version-history When included on a versioned resource, this link points to a resource containing the version history for this resource. Undefined; this relation can be used for background processing or to provide extended functionality without displaying its value. Automated agents should take care when these relations cross administrative domains (e.g., the URI has a different authority than the current document). Such agents should also take care to detect circular references. Care should be applied when versioned resources are subject to differing access policies. In this case, exposing links may leak information even if the linked resource itself is properly secured. In particular, the syntax of the link URI/IRI could expose sensitive information (see Section 16.2 of [RFC3253] for a similar consideration in WebDAV Versioning). Note that this applies to exposing link metadata in general, not only to links related to versioning. [RFC-brown-versioning-link-relations-07]
via [RFC4287]
working-copy When included on a versioned resource, this link points to a working copy for this resource. Some systems may allow multiple of these link relations. Undefined; this relation can be used for background processing or to provide extended functionality without displaying its value. Automated agents should take care when these relations cross administrative domains (e.g., the URI has a different authority than the current document). Such agents should also take care to detect circular references. Care should be applied when versioned resources are subject to differing access policies. In this case, exposing links may leak information even if the linked resource itself is properly secured. In particular, the syntax of the link URI/IRI could expose sensitive information (see Section 16.2 of [RFC3253] for a similar consideration in WebDAV Versioning). Note that this applies to exposing link metadata in general, not only to links related to versioning. [RFC-brown-versioning-link-relations-07]
working-copy-of When included on a working copy, this link points to the versioned resource from which this working copy was obtained. Undefined; this relation can be used for background processing or to provide extended functionality without displaying its value. Automated agents should take care when these relations cross administrative domains (e.g., the URI has a different authority than the current document). Such agents should also take care to detect circular references. Care should be applied when versioned resources are subject to differing access policies. In this case, exposing links may leak information even if the linked resource itself is properly secured. In particular, the syntax of the link URI/IRI could expose sensitive information (see Section 16.2 of [RFC3253] for a similar consideration in WebDAV Versioning). Note that this applies to exposing link metadata in general, not only to links related to versioning. [RFC-brown-versioning-link-relations-07]

People

ID Name Contact URI Last Updated
[Brett_Slatkin] Brett Slatkin bslatkin&google.com 2009-11-20
[James_Snell] James Snell jasnell&gmail.com 2008-05-20
[Joshua_Kinberg] Joshua Kinberg jkinberg&gmail.com 2006-02
[Noah_Slater] Noah Slater nslater&tumbolia.org 2009-01-30
[Phil_Archer] Phil Archer phil&philarcher.org 2009-02-20
[Robert_Sayre] Robert Sayre sayrer&gmail.com 2006-02