From 10ae0e5de9277b3dbfce53fb4240778af523a199 Mon Sep 17 00:00:00 2001 From: radhika Date: Fri, 23 Jun 2017 16:48:32 -0400 Subject: [PATCH] 11860: list method is a duplicate of index method Arvados-DCO-1.1-Signed-off-by: Radhika Chippada --- ...p-collection-lifecycle.html.textile.liquid | 6 +- .../arvados/v1/schema_controller.rb | 63 ++++--------------- 2 files changed, 15 insertions(+), 54 deletions(-) diff --git a/doc/user/tutorials/tutorial-keep-collection-lifecycle.html.textile.liquid b/doc/user/tutorials/tutorial-keep-collection-lifecycle.html.textile.liquid index 1bc775a701..c32c057974 100644 --- a/doc/user/tutorials/tutorial-keep-collection-lifecycle.html.textile.liquid +++ b/doc/user/tutorials/tutorial-keep-collection-lifecycle.html.textile.liquid @@ -21,7 +21,7 @@ h2(#collection_attributes). Collection lifecycle attributes As listed above the attributes that are used to manage a collection lifecycle are it's *is_trashed*, *trash_at*, and *delete_at*. The table below lists the values of these attributes and how they influence the state of a collection and it's accessibility. table(table table-bordered table-condensed). -|_. collection state|_. is_trashed|_. trash_at|_. delete_at|_. get|_. index|_. index?include_trash=true|_. can be modified| +|_. collection state|_. is_trashed|_. trash_at|_. delete_at|_. get|_. list|_. list?include_trash=true|_. can be modified| |persisted collection|false |null |null |yes |yes |yes |yes | |expiring collection|false |future |future |yes |yes |yes |yes | |trashed collection|true |past |future |no |no |yes |only is_trashed, trash_at and delete_at attribtues| @@ -47,10 +47,10 @@ A collection can be un-trashed / recovered using either the arv command line too h3. Un-trashing a collection using arv command line tool -You can list the trashed collections using the index command. +You can list the trashed collections using the list command.
-arv collection index --include-trash=true --filters '[["is_trashed", "=", "true"]]'
+arv collection list --include-trash=true --filters '[["is_trashed", "=", "true"]]'
 
You can then untrash a particular collection using arv using it's uuid. diff --git a/services/api/app/controllers/arvados/v1/schema_controller.rb b/services/api/app/controllers/arvados/v1/schema_controller.rb index e1f4ca5770..61ad02bf4a 100644 --- a/services/api/app/controllers/arvados/v1/schema_controller.rb +++ b/services/api/app/controllers/arvados/v1/schema_controller.rb @@ -189,14 +189,14 @@ class Arvados::V1::SchemaController < ApplicationController "https://api.curoverse.com/auth/arvados.readonly" ] }, - list: { - id: "arvados.#{k.to_s.underscore.pluralize}.list", + index: { + id: "arvados.#{k.to_s.underscore.pluralize}.index", path: k.to_s.underscore.pluralize, httpMethod: "GET", description: - %|List #{k.to_s.pluralize}. + %|Index #{k.to_s.pluralize}. - The list method returns a + The index method returns a resource list of matching #{k.to_s.pluralize}. For example: @@ -216,53 +216,6 @@ class Arvados::V1::SchemaController < ApplicationController } |, parameters: { - limit: { - type: "integer", - description: "Maximum number of #{k.to_s.underscore.pluralize} to return.", - default: "100", - format: "int32", - minimum: "0", - location: "query", - }, - offset: { - type: "integer", - description: "Number of #{k.to_s.underscore.pluralize} to skip before first returned record.", - default: "0", - format: "int32", - minimum: "0", - location: "query", - }, - filters: { - type: "array", - description: "Conditions for filtering #{k.to_s.underscore.pluralize}.", - location: "query" - }, - where: { - type: "object", - description: "Conditions for filtering #{k.to_s.underscore.pluralize}. (Deprecated. Use filters instead.)", - location: "query" - }, - order: { - type: "string", - description: "Order in which to return matching #{k.to_s.underscore.pluralize}.", - location: "query" - }, - select: { - type: "array", - description: "Select which fields to return.", - location: "query" - }, - distinct: { - type: "boolean", - description: "Return each distinct object.", - location: "query" - }, - count: { - type: "string", - description: "Type of count to return in items_available ('none' or 'exact').", - default: "exact", - location: "query" - } }, response: { "$ref" => "#{k.to_s}List" @@ -405,6 +358,14 @@ class Arvados::V1::SchemaController < ApplicationController end end d_methods[action.to_sym] = method + + if action == 'index' + list_method = method.dup + list_method[:id].sub!('index', 'list') + list_method[:description].sub!('Index', 'List') + list_method[:description].sub!('index', 'list') + d_methods[:list] = list_method + end end end end -- 2.30.2