X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/3dc2b0008be4e09b47f73aeeb97d005cd7836619..20abd5d545f9f1102bcd28ee4cab7a2453e28cb4:/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 0baa865502..c108fb898d 100644
--- a/services/api/app/controllers/arvados/v1/schema_controller.rb
+++ b/services/api/app/controllers/arvados/v1/schema_controller.rb
@@ -1,28 +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 :require_auth_scope_all
+ 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
- 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!
discovery = {
@@ -32,16 +20,19 @@ class Arvados::V1::SchemaController < ApplicationController
name: "arvados",
version: "v1",
revision: "20131114",
+ source_version: (Rails.application.config.source_version ? Rails.application.config.source_version : "No version information available") + (Rails.application.config.local_modified ? Rails.application.config.local_modified.to_s : ''),
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",
+ 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,
parameters: {
alt: {
type: "string",
@@ -74,10 +65,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"
}
}
@@ -86,7 +77,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
@@ -147,6 +144,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",
@@ -180,51 +178,85 @@ 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: {
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"
+ minimum: "0",
+ location: "query",
},
- q: {
- type: "string",
- description: "Query string for searching #{k.to_s.underscore.pluralize}.",
+ 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}.",
+ 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"
}
},
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: {
@@ -232,16 +264,9 @@ 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.underscore => {
"$ref" => k.to_s
@@ -252,7 +277,7 @@ class Arvados::V1::SchemaController < ApplicationController
"$ref" => k.to_s
},
scopes: [
- "https://api.clinicalfuture.com/auth/arvados"
+ "https://api.curoverse.com/auth/arvados"
]
},
update: {
@@ -266,16 +291,10 @@ 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.underscore => {
"$ref" => k.to_s
@@ -286,7 +305,7 @@ class Arvados::V1::SchemaController < ApplicationController
"$ref" => k.to_s
},
scopes: [
- "https://api.clinicalfuture.com/auth/arvados"
+ "https://api.curoverse.com/auth/arvados"
]
},
delete: {
@@ -306,7 +325,7 @@ class Arvados::V1::SchemaController < ApplicationController
"$ref" => k.to_s
},
scopes: [
- "https://api.clinicalfuture.com/auth/arvados"
+ "https://api.curoverse.com/auth/arvados"
]
}
}
@@ -321,31 +340,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
- 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"
- }
+ 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|
@@ -354,6 +379,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')
@@ -362,12 +391,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