1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: AGPL-3.0
5 class Arvados::V1::SchemaController < ApplicationController
6 skip_before_action :catch_redirect_hint
7 skip_before_action :find_objects_for_index
8 skip_before_action :find_object_by_uuid
9 skip_before_action :load_filters_param
10 skip_before_action :load_limit_offset_order_params
11 skip_before_action :load_read_auths
12 skip_before_action :load_where_param
13 skip_before_action :render_404_if_no_object
14 skip_before_action :require_auth_scope
19 expires_in 24.hours, public: true
20 send_json discovery_doc
26 Rails.cache.fetch 'arvados_v1_rest_discovery' do
27 Rails.application.eager_load!
29 Rails.configuration.RemoteClusters.each {|k,v| if k != "*" then remoteHosts[k] = v["Host"] end }
31 kind: "discovery#restDescription",
32 discoveryVersion: "v1",
37 source_version: AppVersion.hash,
38 sourceVersion: AppVersion.hash, # source_version should be deprecated in the future
39 packageVersion: AppVersion.package_version,
40 generatedAt: db_current_time.iso8601,
42 description: "The API to interact with Arvados.",
43 documentationLink: "http://doc.arvados.org/api/index.html",
44 defaultCollectionReplication: Rails.configuration.Collections["DefaultReplication"],
46 baseUrl: root_url + "arvados/v1/",
47 basePath: "/arvados/v1/",
49 servicePath: "arvados/v1/",
51 uuidPrefix: Rails.configuration.ClusterID,
52 defaultTrashLifetime: Rails.configuration.Collections["DefaultTrashLifetime"],
53 blobSignatureTtl: Rails.configuration.Collections["BlobSigningTTL"],
54 maxRequestSize: Rails.configuration.API["MaxRequestSize"],
55 maxItemsPerResponse: Rails.configuration.API["MaxItemsPerResponse"],
56 dockerImageFormats: Rails.configuration.Containers["SupportedDockerImageFormats"],
57 crunchLogBytesPerEvent: Rails.configuration.Containers["Logging"]["LogBytesPerEvent"],
58 crunchLogSecondsBetweenEvents: Rails.configuration.Containers["Logging"]["LogSecondsBetweenEvents"],
59 crunchLogThrottlePeriod: Rails.configuration.Containers["Logging"]["LogThrottlePeriod"],
60 crunchLogThrottleBytes: Rails.configuration.Containers["Logging"]["LogThrottleBytes"],
61 crunchLogThrottleLines: Rails.configuration.Containers["Logging"]["LogThrottleLines"],
62 crunchLimitLogBytesPerJob: Rails.configuration.Containers["Logging"]["LimitLogBytesPerJob"],
63 crunchLogPartialLineThrottlePeriod: Rails.configuration.Containers["Logging"]["LogPartialLineThrottlePeriod"],
64 crunchLogUpdatePeriod: Rails.configuration.Containers["Logging"]["LogUpdatePeriod"],
65 crunchLogUpdateSize: Rails.configuration.Containers["Logging"]["LogUpdateSize"],
66 remoteHosts: remoteHosts,
67 remoteHostsViaDNS: Rails.configuration.RemoteClusters["*"]["Proxy"],
68 websocketUrl: Rails.configuration.Services["Websocket"]["ExternalURL"].to_s,
69 workbenchUrl: Rails.configuration.Services["Workbench1"]["ExternalURL"].to_s,
70 keepWebServiceUrl: Rails.configuration.Services["WebDAV"]["ExternalURL"].to_s,
71 gitUrl: Rails.configuration.Services["GitHTTP"]["ExternalURL"].to_s,
75 description: "Data format for the response.",
81 "Responses with Content-Type of application/json"
87 description: "Selector specifying which fields to include in a partial response.",
92 description: "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
97 description: "OAuth 2.0 token for the current user.",
104 "https://api.curoverse.com/auth/arvados" => {
105 description: "View and manage objects"
107 "https://api.curoverse.com/auth/arvados.readonly" => {
108 description: "View objects"
117 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
119 ctl_class = "Arvados::V1::#{k.to_s.pluralize}Controller".constantize
121 # No controller -> no discovery.
124 object_properties = {}
126 select { |col| col.name != 'id' && !col.name.start_with?('secret_') }.
128 if k.serialized_attributes.has_key? col.name
129 object_properties[col.name] = {
130 type: k.serialized_attributes[col.name].object_class.to_s
132 elsif k.attribute_types[col.name].is_a? JsonbType::Hash
133 object_properties[col.name] = {
136 elsif k.attribute_types[col.name].is_a? JsonbType::Array
137 object_properties[col.name] = {
141 object_properties[col.name] = {
146 discovery[:schemas][k.to_s + 'List'] = {
148 description: k.to_s + ' list',
153 description: "Object type. Always arvados##{k.to_s.camelcase(:lower)}List.",
154 default: "arvados##{k.to_s.camelcase(:lower)}List"
158 description: "List version."
162 description: "The list of #{k.to_s.pluralize}.",
169 description: "A link to the next page of #{k.to_s.pluralize}."
173 description: "The page token for the next page of #{k.to_s.pluralize}."
177 description: "A link back to this list."
181 discovery[:schemas][k.to_s] = {
185 uuidPrefix: (k.respond_to?(:uuid_prefix) ? k.uuid_prefix : nil),
189 description: "Object ID."
193 description: "Object version."
195 }.merge(object_properties)
197 discovery[:resources][k.to_s.underscore.pluralize] = {
200 id: "arvados.#{k.to_s.underscore.pluralize}.get",
201 path: "#{k.to_s.underscore.pluralize}/{uuid}",
203 description: "Gets a #{k.to_s}'s metadata by UUID.",
207 description: "The UUID of the #{k.to_s} in question.",
219 "https://api.curoverse.com/auth/arvados",
220 "https://api.curoverse.com/auth/arvados.readonly"
224 id: "arvados.#{k.to_s.underscore.pluralize}.index",
225 path: k.to_s.underscore.pluralize,
228 %|Index #{k.to_s.pluralize}.
230 The <code>index</code> method returns a
231 <a href="/api/resources.html">resource list</a> of
232 matching #{k.to_s.pluralize}. For example:
236 "kind":"arvados##{k.to_s.camelcase(:lower)}List",
239 "next_page_token":"",
244 "items_available":745,
246 "request_time":0.157236317
252 "$ref" => "#{k.to_s}List"
255 "https://api.curoverse.com/auth/arvados",
256 "https://api.curoverse.com/auth/arvados.readonly"
260 id: "arvados.#{k.to_s.underscore.pluralize}.create",
261 path: "#{k.to_s.underscore.pluralize}",
263 description: "Create a new #{k.to_s}.",
268 k.to_s.underscore => {
277 "https://api.curoverse.com/auth/arvados"
281 id: "arvados.#{k.to_s.underscore.pluralize}.update",
282 path: "#{k.to_s.underscore.pluralize}/{uuid}",
284 description: "Update attributes of an existing #{k.to_s}.",
288 description: "The UUID of the #{k.to_s} in question.",
296 k.to_s.underscore => {
305 "https://api.curoverse.com/auth/arvados"
309 id: "arvados.#{k.to_s.underscore.pluralize}.delete",
310 path: "#{k.to_s.underscore.pluralize}/{uuid}",
311 httpMethod: "DELETE",
312 description: "Delete an existing #{k.to_s}.",
316 description: "The UUID of the #{k.to_s} in question.",
325 "https://api.curoverse.com/auth/arvados"
330 # Check for Rails routes that don't match the usual actions
332 d_methods = discovery[:resources][k.to_s.underscore.pluralize][:methods]
333 Rails.application.routes.routes.each do |route|
334 action = route.defaults[:action]
335 httpMethod = ['GET', 'POST', 'PUT', 'DELETE'].map { |method|
336 method if route.verb.match(method)
339 route.defaults[:controller] == 'arvados/v1/' + k.to_s.underscore.pluralize and
340 ctl_class.action_methods.include? action
341 if !d_methods[action.to_sym]
343 id: "arvados.#{k.to_s.underscore.pluralize}.#{action}",
344 path: route.path.spec.to_s.sub('/arvados/v1/','').sub('(.:format)','').sub(/:(uu)?id/,'{uuid}'),
345 httpMethod: httpMethod,
346 description: "#{action} #{k.to_s.underscore.pluralize}",
349 "$ref" => (action == 'index' ? "#{k.to_s}List" : k.to_s)
352 "https://api.curoverse.com/auth/arvados"
355 route.segment_keys.each do |key|
357 key = :uuid if key == :id
358 method[:parameters][key] = {
367 # We already built a generic method description, but we
368 # might find some more required parameters through
370 method = d_methods[action.to_sym]
372 if ctl_class.respond_to? "_#{action}_requires_parameters".to_sym
373 ctl_class.send("_#{action}_requires_parameters".to_sym).each do |l, v|
375 method[:parameters][l] = v
377 method[:parameters][l] = {}
379 if !method[:parameters][l][:default].nil?
380 # The JAVA SDK is sensitive to all values being strings
381 method[:parameters][l][:default] = method[:parameters][l][:default].to_s
383 method[:parameters][l][:type] ||= 'string'
384 method[:parameters][l][:description] ||= ''
385 method[:parameters][l][:location] = (route.segment_keys.include?(l) ? 'path' : 'query')
386 if method[:parameters][l][:required].nil?
387 method[:parameters][l][:required] = v != false
391 d_methods[action.to_sym] = method
394 list_method = method.dup
395 list_method[:id].sub!('index', 'list')
396 list_method[:description].sub!('Index', 'List')
397 list_method[:description].sub!('index', 'list')
398 d_methods[:list] = list_method
403 Rails.configuration.API["DisabledAPIs"].each do |method|
404 ctrl, action = method.split('.', 2)
405 discovery[:resources][ctrl][:methods].delete(action.to_sym)