X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/7b8396b7c5b87bcd9d407b9f67f6b6e65c9a6eaa..848940a94d956c26297164cd6c7a51785db82726:/services/api/app/controllers/arvados/v1/schema_controller.rb diff --git a/services/api/app/controllers/arvados/v1/schema_controller.rb b/services/api/app/controllers/arvados/v1/schema_controller.rb index 897afd8da0..7df2edb49f 100644 --- a/services/api/app/controllers/arvados/v1/schema_controller.rb +++ b/services/api/app/controllers/arvados/v1/schema_controller.rb @@ -1,5 +1,6 @@ class Arvados::V1::SchemaController < ApplicationController skip_before_filter :find_object_by_uuid + skip_before_filter :render_404_if_no_object skip_before_filter :require_auth_scope_all def show @@ -23,6 +24,7 @@ class Arvados::V1::SchemaController < ApplicationController end def discovery_rest_description + expires_in 24.hours, public: true discovery = Rails.cache.fetch 'arvados_v1_rest_discovery' do Rails.application.eager_load! discovery = { @@ -147,6 +149,7 @@ class Arvados::V1::SchemaController < ApplicationController id: k.to_s, description: k.to_s, type: "object", + uuidPrefix: (k.respond_to?(:uuid_prefix) ? k.uuid_prefix : nil), properties: { uuid: { type: "string", @@ -188,25 +191,36 @@ class Arvados::V1::SchemaController < ApplicationController id: "arvados.#{k.to_s.underscore.pluralize}.list", path: k.to_s.underscore.pluralize, httpMethod: "GET", - description: "List #{k.to_s.underscore.pluralize}.", + description: + %|List #{k.to_s.pluralize}. + + The list method returns a + resource list of + matching #{k.to_s.pluralize}. For example: + +
+                   {
+                    "kind":"arvados##{k.to_s.camelcase(:lower)}List",
+                    "etag":"",
+                    "self_link":"",
+                    "next_page_token":"",
+                    "next_link":"",
+                    "items":[
+                       ...
+                    ],
+                    "items_available":745,
+                    "_profile":{
+                     "request_time":0.157236317
+                    }
+                    
|, parameters: { limit: { type: "integer", description: "Maximum number of #{k.to_s.underscore.pluralize} to return.", - default: "100", + default: 100, format: "int32", - minimum: "0", - location: "query" - }, - pageToken: { - type: "string", - description: "Page token.", - location: "query" - }, - q: { - type: "string", - description: "Query string for searching #{k.to_s.underscore.pluralize}.", - location: "query" + minimum: 0, + location: "query", }, where: { type: "object", @@ -232,18 +246,11 @@ class Arvados::V1::SchemaController < ApplicationController path: "#{k.to_s.underscore.pluralize}", httpMethod: "POST", description: "Create a new #{k.to_s}.", - parameters: { - k.to_s.underscore => { - type: "object", - required: false, - location: "query", - properties: object_properties - } - }, + parameters: {}, request: { - required: false, + required: true, properties: { - k.to_s => { + k.to_s.underscore => { "$ref" => k.to_s } } @@ -266,18 +273,12 @@ class Arvados::V1::SchemaController < ApplicationController description: "The UUID of the #{k.to_s} in question.", required: true, location: "path" - }, - k.to_s.underscore => { - type: "object", - required: false, - location: "query", - properties: object_properties } }, request: { - required: false, + required: true, properties: { - k.to_s => { + k.to_s.underscore => { "$ref" => k.to_s } } @@ -316,13 +317,16 @@ class Arvados::V1::SchemaController < ApplicationController d_methods = discovery[:resources][k.to_s.underscore.pluralize][:methods] Rails.application.routes.routes.each do |route| action = route.defaults[:action] - httpMethod = (route.verb && route.verb.length > 0) ? route.verb : 'GET' - if route.defaults[:controller] == 'arvados/v1/' + k.to_s.underscore.pluralize and + httpMethod = ['GET', 'POST', 'PUT', 'DELETE'].map { |method| + method if route.verb.match(method) + }.compact.first + if httpMethod and + route.defaults[:controller] == 'arvados/v1/' + k.to_s.underscore.pluralize and !d_methods[action.to_sym] and ctl_class.action_methods.include? action method = { id: "arvados.#{k.to_s.underscore.pluralize}.#{action}", - path: route.path.sub('/arvados/v1/','').sub('(.:format)','').sub(/:(uu)?id/,'{uuid}'), + path: route.path.spec.to_s.sub('/arvados/v1/','').sub('(.:format)','').sub(/:(uu)?id/,'{uuid}'), httpMethod: httpMethod, description: "#{route.defaults[:action]} #{k.to_s.underscore.pluralize}", parameters: {},