X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/ce4675e0b3447611a0154de25ad89595f488890b..f5512fd7f9abe306740af464551938461033a935:/doc/api/methods/links.html.textile.liquid diff --git a/doc/api/methods/links.html.textile.liquid b/doc/api/methods/links.html.textile.liquid index 2e5de1856d..eceea296da 100644 --- a/doc/api/methods/links.html.textile.liquid +++ b/doc/api/methods/links.html.textile.liquid @@ -43,28 +43,30 @@ h3. star A **star** link is a shortcut to a project that is displayed in the user interface (Workbench) as "favorites". Users can mark their own favorites (implemented by creating or deleting **star** links). -An admin can also create **star** links owned by the "All Users" group, these will be displayed to all users that have permission to read the project that has been favorited. +An admin can also create **star** links owned by the "Public favorites" project. These are favorites will be displayed to all users that have permission to read the project that has been favorited. The schema for a star link is: table(table table-bordered table-condensed). |_. Field|_. Value|_. Description| -|owner_uuid|user or group uuid|Either the user that owns the favorite, or the "All Users" group for public favorites.| +|owner_uuid|user or group uuid|Either the user that owns the favorite, or the "Public favorites" group.| +|tail_uuid|user or group uuid|Should be the same as owner_uuid| |head_uuid|project uuid|The project being favorited| |link_class|string of value "star"|Indicates this represents a link to a user favorite| -h4. Creating a favorite +h4. Creating a public favorite -@owner_uuid@ is either an individual user, or the "All Users" group. The @head_uuid@ is the project being favorited. +@owner_uuid@ is either an individual user, or the "Public favorites" group. The @head_uuid@ is the project being favorited.
-$ arv link create --link '{ - "owner_uuid": "zzzzz-j7d0g-fffffffffffffff", - "head_uuid": "zzzzz-j7d0g-theprojectuuid", - "link_class": "star"}' +$ linkuuid=$(arv --format=uuid link create --link '{ + "link_class": "star", + "owner_uuid": "zzzzz-j7d0g-publicfavorites", + "tail_uuid": "zzzzz-j7d0g-publicfavorites", + "head_uuid": "zzzzz-j7d0g-theprojectuuid"}')-h4. Deleting a favorite +h4. Removing a favorite
$ arv link delete --uuid zzzzz-o0j2j-thestarlinkuuid @@ -77,7 +79,7 @@ To list all 'star' links that will be displayed for a user:$ arv link list --filters '[ ["link_class", "=", "star"], - ["owner_uuid", "in", ["zzzzz-j7d0g-fffffffffffffff", "zzzzz-tpzed-currentuseruuid"]]]' + ["tail_uuid", "in", ["zzzzz-j7d0g-publicfavorites", "zzzzz-tpzed-currentuseruuid"]]]'h3. tag @@ -141,3 +143,13 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Link in question.|path|| |link|object||query|| + +h3. get_permissions + +Get all permission links that point directly to given UUID (in the head_uuid field). The requesting user must have @can_manage@ permission or be an admin. + +Arguments: + +table(table table-bordered table-condensed). +|_. Argument |_. Type |_. Description |_. Location |_. Example | +{background:#ccffcc}.|uuid|string|The UUID of the object.|path||