X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/dcbb5acc0f9767c6b358e5f5d6055b78290430ab..82b46502f25b6992c93bfe7689acc095aa447e5b:/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 dde592ee8a..5d907b89ac 100644 --- a/services/api/app/controllers/arvados/v1/schema_controller.rb +++ b/services/api/app/controllers/arvados/v1/schema_controller.rb @@ -1,29 +1,10 @@ class Arvados::V1::SchemaController < ApplicationController + skip_before_filter :find_objects_for_index skip_before_filter :find_object_by_uuid skip_before_filter :render_404_if_no_object - skip_before_filter :require_auth_scope_all + skip_before_filter :require_auth_scope - def show - classes = Rails.cache.fetch 'arvados_v1_schema' do - Rails.application.eager_load! - classes = {} - ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k| - classes[k] = k.columns.collect do |col| - if k.serialized_attributes.has_key? col.name - { name: col.name, - type: k.serialized_attributes[col.name].object_class.to_s } - else - { name: col.name, - type: col.type } - end - end - end - classes - end - render json: classes - end - - def discovery_rest_description + def index expires_in 24.hours, public: true discovery = Rails.cache.fetch 'arvados_v1_rest_discovery' do Rails.application.eager_load! @@ -37,9 +18,9 @@ class Arvados::V1::SchemaController < ApplicationController generatedAt: Time.now.iso8601, title: "Arvados API", description: "The API to interact with Arvados.", - documentationLink: "https://redmine.clinicalfuture.com/projects/arvados/", + documentationLink: "http://doc.arvados.org/api/index.html", protocol: "rest", - baseUrl: root_url + "/arvados/v1/", + baseUrl: root_url + "arvados/v1/", basePath: "/arvados/v1/", rootUrl: root_url, servicePath: "arvados/v1/", @@ -88,7 +69,13 @@ class Arvados::V1::SchemaController < ApplicationController schemas: {}, resources: {} } - + + if Rails.application.config.websocket_address + discovery[:websocketUrl] = Rails.application.config.websocket_address + elsif ENV['ARVADOS_WEBSOCKETS'] + discovery[:websocketUrl] = (root_url.sub /^http/, 'ws') + "websocket" + end + ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k| begin ctl_class = "Arvados::V1::#{k.to_s.pluralize}Controller".constantize @@ -194,7 +181,7 @@ class Arvados::V1::SchemaController < ApplicationController description: %|List #{k.to_s.pluralize}. - The list method returns a + The list method returns a resource list of matching #{k.to_s.pluralize}. For example: @@ -217,11 +204,19 @@ class Arvados::V1::SchemaController < ApplicationController limit: { type: "integer", description: "Maximum number of #{k.to_s.underscore.pluralize} to return.", - default: 100, + default: "100", format: "int32", - minimum: 0, + 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}.", @@ -236,6 +231,16 @@ class Arvados::V1::SchemaController < ApplicationController 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" } }, response: { @@ -328,7 +333,8 @@ class Arvados::V1::SchemaController < ApplicationController 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 + ctl_class.action_methods.include? action and + ![:show, :index, :destroy].include?(action.to_sym) method = { id: "arvados.#{k.to_s.underscore.pluralize}.#{action}", path: route.path.spec.to_s.sub('/arvados/v1/','').sub('(.:format)','').sub(/:(uu)?id/,'{uuid}'), @@ -360,6 +366,9 @@ class Arvados::V1::SchemaController < ApplicationController else method[:parameters][k] = {} end + if !method[:parameters][k][:default].nil? + method[:parameters][k][:default] = 'string' + end method[:parameters][k][:type] ||= 'string' method[:parameters][k][:description] ||= '' method[:parameters][k][:location] = (route.segment_keys.include?(k) ? 'path' : 'query')