X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/da67c81ff6cc5fd540c0725de1c8208c2d8933be..c1ac820b37938e3b9a533d93b55eb12a0808cf0d:/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 625519e89c..ba0f90f90c 100644 --- a/services/api/app/controllers/arvados/v1/schema_controller.rb +++ b/services/api/app/controllers/arvados/v1/schema_controller.rb @@ -1,9 +1,16 @@ class Arvados::V1::SchemaController < ApplicationController + skip_before_filter :catch_redirect_hint skip_before_filter :find_objects_for_index skip_before_filter :find_object_by_uuid + skip_before_filter :load_filters_param + skip_before_filter :load_limit_offset_order_params + skip_before_filter :load_read_auths + skip_before_filter :load_where_param skip_before_filter :render_404_if_no_object skip_before_filter :require_auth_scope + include DbCurrentTime + def index expires_in 24.hours, public: true discovery = Rails.cache.fetch 'arvados_v1_rest_discovery' do @@ -15,16 +22,21 @@ class Arvados::V1::SchemaController < ApplicationController name: "arvados", version: "v1", revision: "20131114", - generatedAt: Time.now.iso8601, + source_version: AppVersion.hash, + generatedAt: db_current_time.iso8601, title: "Arvados API", description: "The API to interact with Arvados.", documentationLink: "http://doc.arvados.org/api/index.html", + defaultCollectionReplication: Rails.configuration.default_collection_replication, protocol: "rest", - baseUrl: root_url + "/arvados/v1/", + baseUrl: root_url + "arvados/v1/", basePath: "/arvados/v1/", rootUrl: root_url, servicePath: "arvados/v1/", batchPath: "batch", + defaultTrashLifetime: Rails.application.config.default_trash_lifetime, + blobSignatureTtl: Rails.application.config.blob_signature_ttl, + maxRequestSize: Rails.application.config.max_request_size, parameters: { alt: { type: "string", @@ -57,10 +69,10 @@ class Arvados::V1::SchemaController < ApplicationController auth: { oauth2: { scopes: { - "https://api.clinicalfuture.com/auth/arvados" => { + "https://api.curoverse.com/auth/arvados" => { description: "View and manage objects" }, - "https://api.clinicalfuture.com/auth/arvados.readonly" => { + "https://api.curoverse.com/auth/arvados.readonly" => { description: "View objects" } } @@ -70,6 +82,12 @@ class Arvados::V1::SchemaController < ApplicationController 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 @@ -164,8 +182,8 @@ class Arvados::V1::SchemaController < ApplicationController "$ref" => k.to_s }, scopes: [ - "https://api.clinicalfuture.com/auth/arvados", - "https://api.clinicalfuture.com/auth/arvados.readonly" + "https://api.curoverse.com/auth/arvados", + "https://api.curoverse.com/auth/arvados.readonly" ] }, list: { @@ -198,17 +216,17 @@ 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, + default: "0", format: "int32", - minimum: 0, + minimum: "0", location: "query", }, filters: { @@ -225,14 +243,24 @@ 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: { "$ref" => "#{k.to_s}List" }, scopes: [ - "https://api.clinicalfuture.com/auth/arvados", - "https://api.clinicalfuture.com/auth/arvados.readonly" + "https://api.curoverse.com/auth/arvados", + "https://api.curoverse.com/auth/arvados.readonly" ] }, create: { @@ -253,7 +281,7 @@ class Arvados::V1::SchemaController < ApplicationController "$ref" => k.to_s }, scopes: [ - "https://api.clinicalfuture.com/auth/arvados" + "https://api.curoverse.com/auth/arvados" ] }, update: { @@ -281,7 +309,7 @@ class Arvados::V1::SchemaController < ApplicationController "$ref" => k.to_s }, scopes: [ - "https://api.clinicalfuture.com/auth/arvados" + "https://api.curoverse.com/auth/arvados" ] }, delete: { @@ -301,7 +329,7 @@ class Arvados::V1::SchemaController < ApplicationController "$ref" => k.to_s }, scopes: [ - "https://api.clinicalfuture.com/auth/arvados" + "https://api.curoverse.com/auth/arvados" ] } } @@ -316,32 +344,37 @@ class Arvados::V1::SchemaController < ApplicationController }.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 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}'), - httpMethod: httpMethod, - description: "#{route.defaults[:action]} #{k.to_s.underscore.pluralize}", - parameters: {}, - response: { - "$ref" => (action == 'index' ? "#{k.to_s}List" : k.to_s) - }, - scopes: [ - "https://api.clinicalfuture.com/auth/arvados" - ] - } - route.segment_keys.each do |key| - if key != :format - key = :uuid if key == :id - method[:parameters][key] = { - type: "string", - description: "", - required: true, - location: "path" - } + ctl_class.action_methods.include? action + if !d_methods[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}'), + httpMethod: httpMethod, + description: "#{action} #{k.to_s.underscore.pluralize}", + parameters: {}, + response: { + "$ref" => (action == 'index' ? "#{k.to_s}List" : k.to_s) + }, + scopes: [ + "https://api.curoverse.com/auth/arvados" + ] + } + route.segment_keys.each do |key| + if key != :format + key = :uuid if key == :id + method[:parameters][key] = { + type: "string", + description: "", + required: true, + location: "path" + } + end end + else + # We already built a generic method description, but we + # might find some more required parameters through + # introspection. + method = d_methods[action.to_sym] end if ctl_class.respond_to? "_#{action}_requires_parameters".to_sym ctl_class.send("_#{action}_requires_parameters".to_sym).each do |k, v| @@ -350,6 +383,10 @@ class Arvados::V1::SchemaController < ApplicationController else method[:parameters][k] = {} end + if !method[:parameters][k][:default].nil? + # The JAVA SDK is sensitive to all values being strings + method[:parameters][k][:default] = method[:parameters][k][:default].to_s + end method[:parameters][k][:type] ||= 'string' method[:parameters][k][:description] ||= '' method[:parameters][k][:location] = (route.segment_keys.include?(k) ? 'path' : 'query') @@ -358,12 +395,12 @@ class Arvados::V1::SchemaController < ApplicationController end end end - d_methods[route.defaults[:action].to_sym] = method + d_methods[action.to_sym] = method end end end discovery end - render json: discovery + send_json discovery end end