class Arvados::V1::SchemaController < ApplicationController
+ skip_before_filter :find_objects_for_index
skip_before_filter :find_object_by_uuid
+ 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 = {
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/",
id: k.to_s,
description: k.to_s,
type: "object",
+ uuidPrefix: (k.respond_to?(:uuid_prefix) ? k.uuid_prefix : nil),
properties: {
uuid: {
type: "string",
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 <code>list</code> method returns a
+ <a href="/api/resources.html">resource list</a> of
+ matching #{k.to_s.pluralize}. For example:
+
+ <pre>
+ {
+ "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
+ }
+ </pre>|,
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: {
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 => {
+ k.to_s.underscore => {
"$ref" => k.to_s
}
}
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 => {
+ k.to_s.underscore => {
"$ref" => k.to_s
}
}
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.spec.to_s.sub('/arvados/v1/','').sub('(.:format)','').sub(/:(uu)?id/,'{uuid}'),