Merge branch 'master' into 1786-replace-jekyll-with-zenweb
[arvados.git] / doc / api / schema / Link.textile
index 117c10cb164e921e4d6065492a350f75e646481e..952d6f04857ad2c58678771f8c32fffa173f0941 100644 (file)
@@ -10,7 +10,7 @@ h1. Link
 
 **Links** describe relationships between Arvados objects, and from objects to primitives.
 
-Links are directional: each metadata object has a tail (subject), class, name, properties, and head (object or value).  A Link may describe a relationship between two objects in an Arvados database: e.g. a _permission_ link between a User and a Group defines the permissions that User has to read or modify the Group.  Other Links simply represent metadata for a single object, e.g. the _identifier_ Link, in which the _name_ property represents a human-readable identifier for the object at the link's head.
+Links are directional: each metadata object has a tail (the "subject" being described), class, name, properties, and head (the "object" that describes the "subject").  A Link may describe a relationship between two objects in an Arvados database: e.g. a _permission_ link between a User and a Group defines the permissions that User has to read or modify the Group.  Other Links simply represent metadata for a single object, e.g. the _identifier_ Link, in which the _name_ property represents a human-readable identifier for the object at the link's head.
 
 For links that don't make sense to share between API clients, a _link_class_ that begins with @client@ (like @client.my_app_id@ or @client.my_app_id.anythinghere@) should be used.