Link Relations for Simple Version NavigationIBM3565 Harbor BlvdCosta MesaCalifornia92626USalbertcbrown@us.ibm.comIBM20 Maguire RoadLexingtonMA02421USgeoffrey.clemm@us.ibm.comgreenbytes GmbHHafenweg 16MuensterNW48155Germanyjulian.reschke@greenbytes.dehttp://greenbytes.de/tech/webdav/
This specification defines Atom link relations for navigation between
a resource and its versions.
Please send comments to the Atom Syntax mailing list
().
Umbrella issue for editorial fixes/enhancements.
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.
Versioned Resource
When a resource is put under version control, it becomes a "versioned
resource". A versioned resource can be "checked out" to allow
modification.
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
modified to create a new version of a versioned resource.
Use proper IANA registration template.
The following link relations are defined:
version-history
When included on a versioned resource, this link points to a resource
containing the version history for this resource.
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.
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.
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.
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.
The following link relations are defined:
When included on a versioned resource, this link points to a resource
containing the version history for this resource.
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.
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.
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.
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.
The link relations below are to be registered by IANA per :
version-history
See .
Undefined; this relation can be used for background processing or to provide
extended functionality without displaying its value.
See .
latest-version
See .
Undefined; this relation can be used for background processing or to provide
extended functionality without displaying its value.
See .
working-copy
See .
Undefined; this relation can be used for background processing or to provide
extended functionality without displaying its value.
See .
predecessor-version
See .
Undefined; this relation can be used for background processing or to provide
extended functionality without displaying its value.
See .
successor-version
See .
Undefined; this relation can be used for background processing or to provide
extended functionality without displaying its value.
See .
Automated agents should take care when these 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.
The link relations defined in are to be
registered by IANA per .
Will be updated to follow once approved by the IESG.
All link relations defined in this document will have the following
expected display characteristics:
Undefined; this relation can be used for background processing or to provide
extended functionality without displaying its value.
The Atom Syndication FormatVersioning Extensions to WebDAV (Web Distributed
Authoring and Versioning)Rational Software (IBM)IBMMicrosoftU.C. Santa CruzContent Repository API for Java™ Technology SpecificationDay SoftwareDay SoftwareDay SoftwareWeb Linkingmnot@mnot.nethttp://www.mnot.net/
The link relations defined in correspond to
various properties used in WebDAV Versioning
and JCR :
version-history
WebDAV: the resource identified by the DAV:version-history property
(, Sections and ).
JCR: the node identified by jcr:versionHistory
property () for
versionable nodes, the parent folder for version nodes.
latest-version
WebDAV: for version-controlled resources, DAV:checked-in () or
DAV:checked-out (), 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 ()
for versionable nodes; for version nodes, a successor version that itself does
not have any successors.
working-resource
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 ).
JCR: for checked-out versionable nodes: the node itself.
predecessor-version
WebDAV: each resource identified by a member of DAV:predecessor-set (, Sections and ).
JCR: each node identified by a member of jcr:predecessors ().
successor-version
WebDAV: each resource identified by a member of DAV:successor-set ().
JCR: each node identified by a member of jcr:successors ().
The "Web Linking" specification ()
generalizes Atom link relations, and also re-introduces the HTTP "Link"
header as a way to expose link relations in HTTP responses. This will make
it possible to expose version links independently from a specific vocabulary,
be it the Atom Feed Format () or WebDAV properties
().
For instance, a response to an VERSION-CONTROL request () could
expose newly created version-history and checked-in version as link relations:
A subsequent HEAD request on that resource could expose the version-history
and latest-version relations as well:
After creating more versions, following the latest-version would then expose
predecessors of a version:
The content and concepts within are a product of the Content Management
Interoperability Services (CMIS) Technical Committee (TC) at OASIS.
All members of the TC have contributed.
Added Geoff Clemm as author.
Renamed link relation "all-versions" to "version-history". Fixed
description of "working-resource" relation to state that it appears
on a version resource.
Rewrite terminology and link relations using simpler definitions
that can reflect versioning approaches different from WebDAV.
Add JCR/WebDAV property table. And reference to Web Linking draft
(for now informative) and examples showing use of the Link header.
Add and resolve issue "iana".