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_select_param
12 skip_before_action :load_read_auths
13 skip_before_action :load_where_param
14 skip_before_action :render_404_if_no_object
15 skip_before_action :require_auth_scope
20 expires_in 24.hours, public: true
21 send_json discovery_doc
27 Rails.cache.fetch 'arvados_v1_rest_discovery' do
28 Rails.application.eager_load!
30 Rails.configuration.RemoteClusters.each {|k,v| if k != :"*" then remoteHosts[k] = v["Host"] end }
32 kind: "discovery#restDescription",
33 discoveryVersion: "v1",
37 # format is YYYYMMDD, must be fixed width (needs to be lexically
38 # sortable), updated manually, may be used by clients to
39 # determine availability of API server features.
41 source_version: AppVersion.hash,
42 sourceVersion: AppVersion.hash, # source_version should be deprecated in the future
43 packageVersion: AppVersion.package_version,
44 generatedAt: db_current_time.iso8601,
46 description: "The API to interact with Arvados.",
47 documentationLink: "http://doc.arvados.org/api/index.html",
48 defaultCollectionReplication: Rails.configuration.Collections.DefaultReplication,
50 baseUrl: root_url + "arvados/v1/",
51 basePath: "/arvados/v1/",
53 servicePath: "arvados/v1/",
55 uuidPrefix: Rails.configuration.ClusterID,
56 defaultTrashLifetime: Rails.configuration.Collections.DefaultTrashLifetime,
57 blobSignatureTtl: Rails.configuration.Collections.BlobSigningTTL,
58 maxRequestSize: Rails.configuration.API.MaxRequestSize,
59 maxItemsPerResponse: Rails.configuration.API.MaxItemsPerResponse,
60 dockerImageFormats: Rails.configuration.Containers.SupportedDockerImageFormats.keys,
61 crunchLogBytesPerEvent: Rails.configuration.Containers.Logging.LogBytesPerEvent,
62 crunchLogSecondsBetweenEvents: Rails.configuration.Containers.Logging.LogSecondsBetweenEvents,
63 crunchLogThrottlePeriod: Rails.configuration.Containers.Logging.LogThrottlePeriod,
64 crunchLogThrottleBytes: Rails.configuration.Containers.Logging.LogThrottleBytes,
65 crunchLogThrottleLines: Rails.configuration.Containers.Logging.LogThrottleLines,
66 crunchLimitLogBytesPerJob: Rails.configuration.Containers.Logging.LimitLogBytesPerJob,
67 crunchLogPartialLineThrottlePeriod: Rails.configuration.Containers.Logging.LogPartialLineThrottlePeriod,
68 crunchLogUpdatePeriod: Rails.configuration.Containers.Logging.LogUpdatePeriod,
69 crunchLogUpdateSize: Rails.configuration.Containers.Logging.LogUpdateSize,
70 remoteHosts: remoteHosts,
71 remoteHostsViaDNS: Rails.configuration.RemoteClusters["*"].Proxy,
72 websocketUrl: Rails.configuration.Services.Websocket.ExternalURL.to_s,
73 workbenchUrl: Rails.configuration.Services.Workbench1.ExternalURL.to_s,
74 workbench2Url: Rails.configuration.Services.Workbench2.ExternalURL.to_s,
75 keepWebServiceUrl: Rails.configuration.Services.WebDAV.ExternalURL.to_s,
76 gitUrl: Rails.configuration.Services.GitHTTP.ExternalURL.to_s,
80 description: "Data format for the response.",
86 "Responses with Content-Type of application/json"
92 description: "Selector specifying which fields to include in a partial response.",
97 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.",
102 description: "OAuth 2.0 token for the current user.",
109 "https://api.arvados.org/auth/arvados" => {
110 description: "View and manage objects"
112 "https://api.arvados.org/auth/arvados.readonly" => {
113 description: "View objects"
122 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
124 ctl_class = "Arvados::V1::#{k.to_s.pluralize}Controller".constantize
126 # No controller -> no discovery.
129 object_properties = {}
131 select { |col| col.name != 'id' && !col.name.start_with?('secret_') }.
133 if k.serialized_attributes.has_key? col.name
134 object_properties[col.name] = {
135 type: k.serialized_attributes[col.name].object_class.to_s
137 elsif k.attribute_types[col.name].is_a? JsonbType::Hash
138 object_properties[col.name] = {
141 elsif k.attribute_types[col.name].is_a? JsonbType::Array
142 object_properties[col.name] = {
146 object_properties[col.name] = {
151 discovery[:schemas][k.to_s + 'List'] = {
153 description: k.to_s + ' list',
158 description: "Object type. Always arvados##{k.to_s.camelcase(:lower)}List.",
159 default: "arvados##{k.to_s.camelcase(:lower)}List"
163 description: "List version."
167 description: "The list of #{k.to_s.pluralize}.",
174 description: "A link to the next page of #{k.to_s.pluralize}."
178 description: "The page token for the next page of #{k.to_s.pluralize}."
182 description: "A link back to this list."
186 discovery[:schemas][k.to_s] = {
190 uuidPrefix: (k.respond_to?(:uuid_prefix) ? k.uuid_prefix : nil),
194 description: "Object ID."
198 description: "Object version."
200 }.merge(object_properties)
202 discovery[:resources][k.to_s.underscore.pluralize] = {
205 id: "arvados.#{k.to_s.underscore.pluralize}.get",
206 path: "#{k.to_s.underscore.pluralize}/{uuid}",
208 description: "Gets a #{k.to_s}'s metadata by UUID.",
212 description: "The UUID of the #{k.to_s} in question.",
224 "https://api.arvados.org/auth/arvados",
225 "https://api.arvados.org/auth/arvados.readonly"
229 id: "arvados.#{k.to_s.underscore.pluralize}.index",
230 path: k.to_s.underscore.pluralize,
233 %|Index #{k.to_s.pluralize}.
235 The <code>index</code> method returns a
236 <a href="/api/resources.html">resource list</a> of
237 matching #{k.to_s.pluralize}. For example:
241 "kind":"arvados##{k.to_s.camelcase(:lower)}List",
244 "next_page_token":"",
249 "items_available":745,
251 "request_time":0.157236317
257 "$ref" => "#{k.to_s}List"
260 "https://api.arvados.org/auth/arvados",
261 "https://api.arvados.org/auth/arvados.readonly"
265 id: "arvados.#{k.to_s.underscore.pluralize}.create",
266 path: "#{k.to_s.underscore.pluralize}",
268 description: "Create a new #{k.to_s}.",
273 k.to_s.underscore => {
282 "https://api.arvados.org/auth/arvados"
286 id: "arvados.#{k.to_s.underscore.pluralize}.update",
287 path: "#{k.to_s.underscore.pluralize}/{uuid}",
289 description: "Update attributes of an existing #{k.to_s}.",
293 description: "The UUID of the #{k.to_s} in question.",
301 k.to_s.underscore => {
310 "https://api.arvados.org/auth/arvados"
314 id: "arvados.#{k.to_s.underscore.pluralize}.delete",
315 path: "#{k.to_s.underscore.pluralize}/{uuid}",
316 httpMethod: "DELETE",
317 description: "Delete an existing #{k.to_s}.",
321 description: "The UUID of the #{k.to_s} in question.",
330 "https://api.arvados.org/auth/arvados"
335 # Check for Rails routes that don't match the usual actions
337 d_methods = discovery[:resources][k.to_s.underscore.pluralize][:methods]
338 Rails.application.routes.routes.each do |route|
339 action = route.defaults[:action]
340 httpMethod = ['GET', 'POST', 'PUT', 'DELETE'].map { |method|
341 method if route.verb.match(method)
344 route.defaults[:controller] == 'arvados/v1/' + k.to_s.underscore.pluralize and
345 ctl_class.action_methods.include? action
346 if !d_methods[action.to_sym]
348 id: "arvados.#{k.to_s.underscore.pluralize}.#{action}",
349 path: route.path.spec.to_s.sub('/arvados/v1/','').sub('(.:format)','').sub(/:(uu)?id/,'{uuid}'),
350 httpMethod: httpMethod,
351 description: "#{action} #{k.to_s.underscore.pluralize}",
354 "$ref" => (action == 'index' ? "#{k.to_s}List" : k.to_s)
357 "https://api.arvados.org/auth/arvados"
360 route.segment_keys.each do |key|
362 key = :uuid if key == :id
363 method[:parameters][key] = {
372 # We already built a generic method description, but we
373 # might find some more required parameters through
375 method = d_methods[action.to_sym]
377 if ctl_class.respond_to? "_#{action}_requires_parameters".to_sym
378 ctl_class.send("_#{action}_requires_parameters".to_sym).each do |l, v|
380 method[:parameters][l] = v
382 method[:parameters][l] = {}
384 if !method[:parameters][l][:default].nil?
385 # The JAVA SDK is sensitive to all values being strings
386 method[:parameters][l][:default] = method[:parameters][l][:default].to_s
388 method[:parameters][l][:type] ||= 'string'
389 method[:parameters][l][:description] ||= ''
390 method[:parameters][l][:location] = (route.segment_keys.include?(l) ? 'path' : 'query')
391 if method[:parameters][l][:required].nil?
392 method[:parameters][l][:required] = v != false
396 d_methods[action.to_sym] = method
399 list_method = method.dup
400 list_method[:id].sub!('index', 'list')
401 list_method[:description].sub!('Index', 'List')
402 list_method[:description].sub!('index', 'list')
403 d_methods[:list] = list_method
409 discovery[:resources]['configs'] = {
412 id: "arvados.configs.get",
415 description: "Get public config",
423 "https://api.arvados.org/auth/arvados",
424 "https://api.arvados.org/auth/arvados.readonly"
430 discovery[:resources]['vocabularies'] = {
433 id: "arvados.vocabularies.get",
436 description: "Get vocabulary definition",
444 "https://api.arvados.org/auth/arvados",
445 "https://api.arvados.org/auth/arvados.readonly"
451 discovery[:resources]['sys'] = {
454 id: "arvados.sys.trash_sweep",
455 path: "sys/trash_sweep",
457 description: "apply scheduled trash and delete operations",
465 "https://api.arvados.org/auth/arvados",
466 "https://api.arvados.org/auth/arvados.readonly"
472 Rails.configuration.API.DisabledAPIs.each do |method, _|
473 ctrl, action = method.to_s.split('.', 2)
474 discovery[:resources][ctrl][:methods].delete(action.to_sym)