X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/43c411ec1441ee1710dc33389d7451f7414a170f..de298e4e20a7ed07e16ed3cac87a18a66c0ceb83:/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 6721b44432..f02a56bc62 100644
--- a/services/api/app/controllers/arvados/v1/schema_controller.rb
+++ b/services/api/app/controllers/arvados/v1/schema_controller.rb
@@ -1,6 +1,7 @@
class Arvados::V1::SchemaController < ApplicationController
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
@@ -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 = {
@@ -31,7 +33,8 @@ 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/",
@@ -87,8 +90,12 @@ 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
+ # No controller -> no discovery.
+ next
+ end
object_properties = {}
k.columns.
select { |col| col.name != 'id' }.
@@ -104,8 +111,8 @@ class Arvados::V1::SchemaController < ApplicationController
end
end
discovery[:schemas][k.to_s + 'List'] = {
- id: k.to_s,
- description: k.to_s,
+ id: k.to_s + 'List',
+ description: k.to_s + ' list',
type: "object",
properties: {
kind: {
@@ -142,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",
@@ -183,24 +191,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", + 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}.", 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" } }, @@ -217,16 +259,14 @@ 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: { - "$ref" => k.to_s + required: true, + properties: { + k.to_s.underscore => { + "$ref" => k.to_s + } + } }, response: { "$ref" => k.to_s @@ -246,16 +286,15 @@ 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: { - "$ref" => k.to_s + required: true, + properties: { + k.to_s.underscore => { + "$ref" => k.to_s + } + } }, response: { "$ref" => k.to_s @@ -286,6 +325,61 @@ class Arvados::V1::SchemaController < ApplicationController } } } + # Check for Rails routes that don't match the usual actions + # listed above + d_methods = discovery[:resources][k.to_s.underscore.pluralize][:methods] + Rails.application.routes.routes.each do |route| + action = route.defaults[:action] + 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 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" + } + end + end + if ctl_class.respond_to? "_#{action}_requires_parameters".to_sym + ctl_class.send("_#{action}_requires_parameters".to_sym).each do |k, v| + if v.is_a? Hash + method[:parameters][k] = v + else + method[:parameters][k] = {} + end + method[:parameters][k][:type] ||= 'string' + method[:parameters][k][:description] ||= '' + method[:parameters][k][:location] = (route.segment_keys.include?(k) ? 'path' : 'query') + if method[:parameters][k][:required].nil? + method[:parameters][k][:required] = v != false + end + end + end + d_methods[route.defaults[:action].to_sym] = method + end + end end discovery end