X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/70a643b2532e46cd67b2a647f9c61d61832a5627..c0b66870cafce4d75625e16b5b36bed8b58d7c8e:/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 5f51d806d5..1cc84960de 100644
--- a/services/api/app/controllers/arvados/v1/schema_controller.rb
+++ b/services/api/app/controllers/arvados/v1/schema_controller.rb
@@ -1,28 +1,11 @@
class Arvados::V1::SchemaController < ApplicationController
+ skip_before_filter :find_objects_for_index
skip_before_filter :find_object_by_uuid
- skip_before_filter :login_required
+ skip_before_filter :render_404_if_no_object
+ skip_before_filter :require_auth_scope_all
- 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 = {
@@ -31,10 +14,11 @@ class Arvados::V1::SchemaController < ApplicationController
id: "arvados:v1",
name: "arvados",
version: "v1",
- revision: "20130226",
+ revision: "20131114",
+ 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/",
basePath: "/arvados/v1/",
@@ -87,8 +71,6 @@ class Arvados::V1::SchemaController < ApplicationController
}
ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
- next if k == ApiClientAuthorization
- next if k == ApiClient
begin
ctl_class = "Arvados::V1::#{k.to_s.pluralize}Controller".constantize
rescue
@@ -148,6 +130,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",
@@ -189,24 +172,58 @@ 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",
+ },
+ offset: {
+ type: "integer",
+ description: "Number of #{k.to_s.underscore.pluralize} to skip before first returned record.",
+ default: 0,
format: "int32",
- minimum: "0",
+ minimum: 0,
+ location: "query",
+ },
+ filters: {
+ type: "array",
+ description: "Conditions for filtering #{k.to_s.underscore.pluralize}.",
location: "query"
},
- pageToken: {
- type: "string",
- description: "Page token.",
+ where: {
+ type: "object",
+ description: "Conditions for filtering #{k.to_s.underscore.pluralize}. (Deprecated. Use filters instead.)",
location: "query"
},
- q: {
+ order: {
type: "string",
- description: "Query string for searching #{k.to_s.underscore.pluralize}.",
+ description: "Order in which to return matching #{k.to_s.underscore.pluralize}.",
location: "query"
}
},
@@ -223,12 +240,13 @@ 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: true,
- location: "query",
- properties: object_properties
+ parameters: {},
+ request: {
+ required: true,
+ properties: {
+ k.to_s.underscore => {
+ "$ref" => k.to_s
+ }
}
},
response: {
@@ -249,12 +267,14 @@ 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: true,
- location: "query",
- properties: object_properties
+ }
+ },
+ request: {
+ required: true,
+ properties: {
+ k.to_s.underscore => {
+ "$ref" => k.to_s
+ }
}
},
response: {
@@ -291,18 +311,22 @@ 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
+ 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.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: {},
response: {
- "$ref" => k.to_s
+ "$ref" => (action == 'index' ? "#{k.to_s}List" : k.to_s)
},
scopes: [
"https://api.clinicalfuture.com/auth/arvados"