log inhelp

View
 

Link types

This version was saved 13 years, 11 months ago View current version     Page history
Saved by Evan Prodromou
on June 5, 2012 at 8:25:05 am
 

The Links for Activity Streams draft describes how to include RFC 5988 links into Activity Streams objects. This document lists the relationship types described in RFC 5988 and in the IANA Link Relation Type Registry and gives some guidance on how to apply them to Activity Streams. The table columns are:

 

  • Relationship: name of the relationship, from the RFC.
  • Applicability: high, medium, low, or none. How applicable this relationship type is to Activity Streams. none means that there already exist properties for this link relationship.
  • Serialization: what kind of things would you include this type of link relationship in? object, collection, activity, other?
  • Notes: any notes or references to other documents
 
Relationship  Applicability  Serialization  Notes  
alternate
 high object, collection, activity
Useful for pointing between Atom and JSON versions of a serialization, or for pointing to a non-ActivityStreams serialization. For HTML, applicability is none since we already have the url property. 
appendix
 low
    
archives
 low     
author
 none   Use the "author" property instead 
bookmark
 low
    
chapter
 low
    
contents
 low
    
copyright
 medium
object, collection, activity
For copyright information or statements. See also "license" 
current
 low
    
describedby
 low
    
edit
 medium
object, collection, activity
Could be useful for AtomPub-like API interface. See ActivityPub
 
edit-media
 medium
object
Could be useful for AtomPub-like API interface. See ActivityPub
 
enclosure
 none
  

Use Media Link serialization instead

 
first
 high
 collection
For partial collections, points to the first partial collection or "page"
 
glossary
 low
    
help
 low
    
hub
 high
 collection
Could be the best way to declare a PubSubHubbub hub, if you can't produce a Link: header. 
index
 low
    
last
 high
 collection
For partial collections, points to the last partial collection or "page" 
latest-version
 low
    
license
 medium
object, collection, activity
Using Creative Commons license URLs here can be very useful. See also "copyright". 
next
 high
 collection
For partial collections, points to the next partial collection or "page" 
next-archive
 low
    
payment
 low
    
prev
 high
collection
For partial collections, points to the previous partial collection or "page" 
predecessor-version
 low
    
previous
 low
 collection
Use "prev" instead. 
prev-archive
 low
    
related
 medium
object, collection, activity
A loose relationship; "see also". 
replies
 none
   Use Responses for Activity Streams instead 
section
 low
    
self
 high
object, collection, activity
Useful to point to the original JSON representation of the object or collection. 
service
 low
collection
Could be useful for AtomPub-like API interface. See ActivityPub 
start
 none
  Use "first" instead 
stylesheet
 none
  Just no reason to use this. 
subsection
 low
    
successor-version
 low
    
up
 low
activity, object
Possibly point from an activity to its "source" collection? 
version-history
 low
    
via
 medium
  ? 
working-copy
 low
    
working-copy-of
 low
   
       

 

 

 

Comments (0)

You don't have permission to comment on this page.

Printable version