Link Relations for Simple Version Navigation

This specification defines Atom link relations for navigation between a resource and its versions.¶

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 June 10, 2010.¶

Copyright (c) 2009 IETF Trust and the persons identified as the document authors. All rights reserved.¶

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.¶

This specification defines link relations that may be used on a resource that exists in a system that supports versioning to navigate among the different resources available, such as past versions.¶

These link relations are used in the AtomPub ([RFC5023]) bindings of the "Content Management Interoperability Services" (CMIS). See Section 3.4.3.1 of [CMIS] for further information.¶

Versioned Resource ¶

• When a resource is put under version control, it becomes a "versioned resource". Many servers protect versioned resources from modifications by considering them "checked in", and by requiring a "checkout" operation before modification, and a "checkin" operation to get back to the "checked-in" state. Other servers allow modification, in which case the checkout/checkin operation may happen implicitly.

Version History ¶

• A "version history" resource is a resource that contains all the versions of a particular versioned resource.

Predecessor, Successor ¶

• When a versioned resource is checked out and then subsequently checked in, the version that was checked out becomes a "predecessor" of the version created by the checkin. A client can specify multiple predecessors for a new version if the new version is logically a merge of those predecessors. The inverse of the predecessor relation is the "successor" relation. Therefore, if X is a predecessor of Y, then Y is a successor of X.

Working Copy ¶

• A "working copy" is a resource at a server-defined URL that can be used to create a new version of a versioned resource.

Checkout ¶

• A "checkout" is an operation on a versioned resource that creates a working copy, or changes the versioned resource to be a working-copy as well ("in-place versioning").

Checkin ¶

• A "checkin" is an operation on a working copy that creates a new version of its corresponding versioned resource.

Automated agents should take care when these relation I ↓s cross↑ I ↓es administrative domains (e.g., the URI has a different authority than the current document). Such agents should also take care to detect circular references.¶

Thanks to the members of Content Management Interoperability Services (CMIS) Technical Committee (TC) at OASIS for the initial proposal, and to Jan Algermissen for feedback during IETF review.¶

version-history ¶

• WebDAV: the resource identified by the DAV:version-history property ([RFC3253], Sections 5.2.1 and 5.3.1).
• JCR: the node identified by jcr:versionHistory property ([JSR-283], Section 3.13.2.4) for versionable nodes, the parent folder for version nodes.

latest-version ¶

• WebDAV: for version-controlled resources, DAV:checked-in ([RFC3253], Section 3.2.1) or DAV:checked-out ([RFC3253], Section 3.3.1), depending on checkin state. For version resources, a successor version that itself does not have any successors.
• JCR: the version node identified by the jcr:baseVersion property ([JSR-283], Section 3.13.2.5) for versionable nodes; for version nodes, a successor version that itself does not have any successors.

working-copy ¶

• WebDAV: for version-controlled resources that are checked-out in place: the resource itself. For version resources: each resource identified by a member of the DAV:checkout-set property (see [RFC3253], Section 3.4.3).
• JCR: for checked-out versionable nodes: the node itself.

working-copy-of ¶

• WebDAV: the resource identified by the the DAV:checked-out property (see [RFC3253], Section 3.3.1).
• JCR: for checked-out versionable nodes: the node identified by the jcr:baseVersion property ([JSR-283], Section 3.13.12.5).

predecessor-version ¶

• WebDAV: each resource identified by a member of DAV:predecessor-set ([RFC3253], Sections 3.3.2 and 3.4.1).
• JCR: each node identified by a member of jcr:predecessors ([JSR-283], Section 3.13.3.3).

successor-version ¶

• WebDAV: each resource identified by a member of DAV:successor-set ([RFC3253], Section 3.4.2).
• JCR: each node identified by a member of jcr:successors ([JSR-283], Section 3.13.3.4).