X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/70a643b2532e46cd67b2a647f9c61d61832a5627..7024cc159936593350aaf7939d700102f6510787:/services/api/app/controllers/arvados/v1/schema_controller.rb?ds=sidebyside
diff --git a/services/api/app/controllers/arvados/v1/schema_controller.rb b/services/api/app/controllers/arvados/v1/schema_controller.rb
index 5f51d806d5..7df2edb49f 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,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 +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",
@@ -189,24 +191,45 @@ 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" + minimum: 0, + location: "query", }, - pageToken: { - type: "string", - description: "Page token.", + where: { + type: "object", + description: "Conditions for filtering #{k.to_s.underscore.pluralize}.", 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 +246,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 +273,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 +317,21 @@ 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 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"