X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/296a8cba6b65654156d3ff3abc07522a4824935e..698f00b7f1c760f504963b42720c7fa2cbc66e48:/doc/api/schema/Link.html.textile.liquid diff --git a/doc/api/schema/Link.html.textile.liquid b/doc/api/schema/Link.html.textile.liquid index 3556055787..4abfdbc249 100644 --- a/doc/api/schema/Link.html.textile.liquid +++ b/doc/api/schema/Link.html.textile.liquid @@ -6,8 +6,6 @@ title: Link ... - - **Links** describe relationships between Arvados objects, and from objects to primitives. 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. @@ -16,9 +14,7 @@ For links that don't make sense to share between API clients, a _link_class_ tha h2. Methods -See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html - -API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/links@ +See "links":{{site.baseurl}}/api/methods/links.html h2. Resource @@ -27,12 +23,10 @@ Each link has, in addition to the usual "attributes of Arvados resources":{{site table(table table-bordered table-condensed). |_. Attribute|_. Type|_. Description| |tail_uuid|string|Object UUID at the tail (start, source, origin) of this link| -|tail_kind|string|Object kind at the tail (start, source, origin) of this link| |link_class|string|Class (see below)| |name|string|Link type (see below)| |head_uuid|string|Object UUID at the head (end, destination, target) of this link| -|head_kind|string|Object kind at the head (end, destination, target) of this link| -|properties{}|list|Additional information, expressed as a key→value hash. Key: string. Value: string, number, array, or hash.| +|properties|hash|Additional information, expressed as a key→value hash. Key: string. Value: string, number, array, or hash.| h2. Link classes @@ -53,9 +47,11 @@ h3. permission table(table table-bordered table-condensed). |_. tail_type→head_type|_. name→head_uuid {properties}|_. Notes| -|User→Group |can_manage → _group uuid_|Writable only by a user who can_manage this group| -|User→Group |can_read → _group uuid_ |Writable only by a user who can_manage this group. -Gives permission to read any object owned by this group.| +|User→Group |{white-space:nowrap}. can_manage → _group uuid_|The User can read, write, and control permissions on the Group itself, every object owned by the Group, and every object on which the Group has _can_manage_ permission.| +|User→Group |can_read → _group uuid_ |The User can retrieve the Group itself and every object that is readable by the Group.| +|User→Job|can_write → _job uuid_ |The User can read and update the Job. (This works for all objects, not just jobs.)| +|User→Job|can_manage → _job uuid_ |The User can read, update, and change permissions for the Job. (This works for all objects, not just jobs.)| +|Group→Job|can_manage → _job uuid_ |Anyone with _can_manage_ permission on the Group can also read, update, and change permissions for the Job. Anyone with _can_read_ permission on the Group can read the Job. (This works for all objects, not just jobs.)| h3. resources