services/api/app/controllers/arvados/v1/schema_controller.rb

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: AGPL-3.0
   4
   5 class Arvados::V1::SchemaController < ApplicationController
   6   skip_before_filter :catch_redirect_hint
   7   skip_before_filter :find_objects_for_index
   8   skip_before_filter :find_object_by_uuid
   9   skip_before_filter :load_filters_param
  10   skip_before_filter :load_limit_offset_order_params
  11   skip_before_filter :load_read_auths
  12   skip_before_filter :load_where_param
  13   skip_before_filter :render_404_if_no_object
  14   skip_before_filter :require_auth_scope
  15
  16   include DbCurrentTime
  17
  18   def index
  19     expires_in 24.hours, public: true
  20     send_json discovery_doc
  21   end
  22
  23   protected
  24
  25   def discovery_doc
  26     Rails.cache.fetch 'arvados_v1_rest_discovery' do
  27       Rails.application.eager_load!
  28       discovery = {
  29         kind: "discovery#restDescription",
  30         discoveryVersion: "v1",
  31         id: "arvados:v1",
  32         name: "arvados",
  33         version: "v1",
  34         revision: "20131114",
  35         source_version: AppVersion.hash,
  36         sourceVersion: AppVersion.hash, # source_version should be deprecated in the future
  37         packageVersion: AppVersion.package_version,
  38         generatedAt: db_current_time.iso8601,
  39         title: "Arvados API",
  40         description: "The API to interact with Arvados.",
  41         documentationLink: "http://doc.arvados.org/api/index.html",
  42         defaultCollectionReplication: Rails.configuration.default_collection_replication,
  43         protocol: "rest",
  44         baseUrl: root_url + "arvados/v1/",
  45         basePath: "/arvados/v1/",
  46         rootUrl: root_url,
  47         servicePath: "arvados/v1/",
  48         batchPath: "batch",
  49         uuidPrefix: Rails.application.config.uuid_prefix,
  50         defaultTrashLifetime: Rails.application.config.default_trash_lifetime,
  51         blobSignatureTtl: Rails.application.config.blob_signature_ttl,
  52         maxRequestSize: Rails.application.config.max_request_size,
  53         dockerImageFormats: Rails.application.config.docker_image_formats,
  54         crunchLogBytesPerEvent: Rails.application.config.crunch_log_bytes_per_event,
  55         crunchLogSecondsBetweenEvents: Rails.application.config.crunch_log_seconds_between_events,
  56         crunchLogThrottlePeriod: Rails.application.config.crunch_log_throttle_period,
  57         crunchLogThrottleBytes: Rails.application.config.crunch_log_throttle_bytes,
  58         crunchLogThrottleLines: Rails.application.config.crunch_log_throttle_lines,
  59         crunchLimitLogBytesPerJob: Rails.application.config.crunch_limit_log_bytes_per_job,
  60         crunchLogPartialLineThrottlePeriod: Rails.application.config.crunch_log_partial_line_throttle_period,
  61         crunchLogUpdatePeriod: Rails.application.config.crunch_log_update_period,
  62         crunchLogUpdateSize: Rails.application.config.crunch_log_update_size,
  63         remoteHosts: Rails.configuration.remote_hosts,
  64         remoteHostsViaDNS: Rails.configuration.remote_hosts_via_dns,
  65         websocketUrl: Rails.application.config.websocket_address,
  66         workbenchUrl: Rails.application.config.workbench_address,
  67         keepWebServiceUrl: Rails.application.config.keep_web_service_url,
  68         gitUrl: case Rails.application.config.git_repo_https_base
  69                 when false
  70                   ''
  71                 when true
  72                   'https://git.%s.arvadosapi.com/' % Rails.configuration.uuid_prefix
  73                 else
  74                   Rails.application.config.git_repo_https_base
  75                 end,
  76         parameters: {
  77           alt: {
  78             type: "string",
  79             description: "Data format for the response.",
  80             default: "json",
  81             enum: [
  82                    "json"
  83                   ],
  84             enumDescriptions: [
  85                                "Responses with Content-Type of application/json"
  86                               ],
  87             location: "query"
  88           },
  89           fields: {
  90             type: "string",
  91             description: "Selector specifying which fields to include in a partial response.",
  92             location: "query"
  93           },
  94           key: {
  95             type: "string",
  96             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             location: "query"
  98           },
  99           oauth_token: {
 100             type: "string",
 101             description: "OAuth 2.0 token for the current user.",
 102             location: "query"
 103           }
 104         },
 105         auth: {
 106           oauth2: {
 107             scopes: {
 108               "https://api.curoverse.com/auth/arvados" => {
 109                 description: "View and manage objects"
 110               },
 111               "https://api.curoverse.com/auth/arvados.readonly" => {
 112                 description: "View objects"
 113               }
 114             }
 115           }
 116         },
 117         schemas: {},
 118         resources: {}
 119       }
 120
 121       ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
 122         begin
 123           ctl_class = "Arvados::V1::#{k.to_s.pluralize}Controller".constantize
 124         rescue
 125           # No controller -> no discovery.
 126           next
 127         end
 128         object_properties = {}
 129         k.columns.
 130           select { |col| col.name != 'id' && !col.name.start_with?('secret_') }.
 131           collect do |col|
 132           if k.serialized_attributes.has_key? col.name
 133             object_properties[col.name] = {
 134               type: k.serialized_attributes[col.name].object_class.to_s
 135             }
 136           else
 137             object_properties[col.name] = {
 138               type: col.type
 139             }
 140           end
 141         end
 142         discovery[:schemas][k.to_s + 'List'] = {
 143           id: k.to_s + 'List',
 144           description: k.to_s + ' list',
 145           type: "object",
 146           properties: {
 147             kind: {
 148               type: "string",
 149               description: "Object type. Always arvados##{k.to_s.camelcase(:lower)}List.",
 150               default: "arvados##{k.to_s.camelcase(:lower)}List"
 151             },
 152             etag: {
 153               type: "string",
 154               description: "List version."
 155             },
 156             items: {
 157               type: "array",
 158               description: "The list of #{k.to_s.pluralize}.",
 159               items: {
 160                 "$ref" => k.to_s
 161               }
 162             },
 163             next_link: {
 164               type: "string",
 165               description: "A link to the next page of #{k.to_s.pluralize}."
 166             },
 167             next_page_token: {
 168               type: "string",
 169               description: "The page token for the next page of #{k.to_s.pluralize}."
 170             },
 171             selfLink: {
 172               type: "string",
 173               description: "A link back to this list."
 174             }
 175           }
 176         }
 177         discovery[:schemas][k.to_s] = {
 178           id: k.to_s,
 179           description: k.to_s,
 180           type: "object",
 181           uuidPrefix: (k.respond_to?(:uuid_prefix) ? k.uuid_prefix : nil),
 182           properties: {
 183             uuid: {
 184               type: "string",
 185               description: "Object ID."
 186             },
 187             etag: {
 188               type: "string",
 189               description: "Object version."
 190             }
 191           }.merge(object_properties)
 192         }
 193         discovery[:resources][k.to_s.underscore.pluralize] = {
 194           methods: {
 195             get: {
 196               id: "arvados.#{k.to_s.underscore.pluralize}.get",
 197               path: "#{k.to_s.underscore.pluralize}/{uuid}",
 198               httpMethod: "GET",
 199               description: "Gets a #{k.to_s}'s metadata by UUID.",
 200               parameters: {
 201                 uuid: {
 202                   type: "string",
 203                   description: "The UUID of the #{k.to_s} in question.",
 204                   required: true,
 205                   location: "path"
 206                 }
 207               },
 208               parameterOrder: [
 209                                "uuid"
 210                               ],
 211               response: {
 212                 "$ref" => k.to_s
 213               },
 214               scopes: [
 215                        "https://api.curoverse.com/auth/arvados",
 216                        "https://api.curoverse.com/auth/arvados.readonly"
 217                       ]
 218             },
 219             index: {
 220               id: "arvados.#{k.to_s.underscore.pluralize}.index",
 221               path: k.to_s.underscore.pluralize,
 222               httpMethod: "GET",
 223               description:
 224                  %|Index #{k.to_s.pluralize}.
 225
 226                    The <code>index</code> method returns a
 227                    <a href="/api/resources.html">resource list</a> of
 228                    matching #{k.to_s.pluralize}. For example:
 229
 230                    <pre>
 231                    {
 232                     "kind":"arvados##{k.to_s.camelcase(:lower)}List",
 233                     "etag":"",
 234                     "self_link":"",
 235                     "next_page_token":"",
 236                     "next_link":"",
 237                     "items":[
 238                        ...
 239                     ],
 240                     "items_available":745,
 241                     "_profile":{
 242                      "request_time":0.157236317
 243                     }
 244                     </pre>|,
 245               parameters: {
 246               },
 247               response: {
 248                 "$ref" => "#{k.to_s}List"
 249               },
 250               scopes: [
 251                        "https://api.curoverse.com/auth/arvados",
 252                        "https://api.curoverse.com/auth/arvados.readonly"
 253                       ]
 254             },
 255             create: {
 256               id: "arvados.#{k.to_s.underscore.pluralize}.create",
 257               path: "#{k.to_s.underscore.pluralize}",
 258               httpMethod: "POST",
 259               description: "Create a new #{k.to_s}.",
 260               parameters: {},
 261               request: {
 262                 required: true,
 263                 properties: {
 264                   k.to_s.underscore => {
 265                     "$ref" => k.to_s
 266                   }
 267                 }
 268               },
 269               response: {
 270                 "$ref" => k.to_s
 271               },
 272               scopes: [
 273                        "https://api.curoverse.com/auth/arvados"
 274                       ]
 275             },
 276             update: {
 277               id: "arvados.#{k.to_s.underscore.pluralize}.update",
 278               path: "#{k.to_s.underscore.pluralize}/{uuid}",
 279               httpMethod: "PUT",
 280               description: "Update attributes of an existing #{k.to_s}.",
 281               parameters: {
 282                 uuid: {
 283                   type: "string",
 284                   description: "The UUID of the #{k.to_s} in question.",
 285                   required: true,
 286                   location: "path"
 287                 }
 288               },
 289               request: {
 290                 required: true,
 291                 properties: {
 292                   k.to_s.underscore => {
 293                     "$ref" => k.to_s
 294                   }
 295                 }
 296               },
 297               response: {
 298                 "$ref" => k.to_s
 299               },
 300               scopes: [
 301                        "https://api.curoverse.com/auth/arvados"
 302                       ]
 303             },
 304             delete: {
 305               id: "arvados.#{k.to_s.underscore.pluralize}.delete",
 306               path: "#{k.to_s.underscore.pluralize}/{uuid}",
 307               httpMethod: "DELETE",
 308               description: "Delete an existing #{k.to_s}.",
 309               parameters: {
 310                 uuid: {
 311                   type: "string",
 312                   description: "The UUID of the #{k.to_s} in question.",
 313                   required: true,
 314                   location: "path"
 315                 }
 316               },
 317               response: {
 318                 "$ref" => k.to_s
 319               },
 320               scopes: [
 321                        "https://api.curoverse.com/auth/arvados"
 322                       ]
 323             }
 324           }
 325         }
 326         # Check for Rails routes that don't match the usual actions
 327         # listed above
 328         d_methods = discovery[:resources][k.to_s.underscore.pluralize][:methods]
 329         Rails.application.routes.routes.each do |route|
 330           action = route.defaults[:action]
 331           httpMethod = ['GET', 'POST', 'PUT', 'DELETE'].map { |method|
 332             method if route.verb.match(method)
 333           }.compact.first
 334           if httpMethod and
 335               route.defaults[:controller] == 'arvados/v1/' + k.to_s.underscore.pluralize and
 336               ctl_class.action_methods.include? action
 337             if !d_methods[action.to_sym]
 338               method = {
 339                 id: "arvados.#{k.to_s.underscore.pluralize}.#{action}",
 340                 path: route.path.spec.to_s.sub('/arvados/v1/','').sub('(.:format)','').sub(/:(uu)?id/,'{uuid}'),
 341                 httpMethod: httpMethod,
 342                 description: "#{action} #{k.to_s.underscore.pluralize}",
 343                 parameters: {},
 344                 response: {
 345                   "$ref" => (action == 'index' ? "#{k.to_s}List" : k.to_s)
 346                 },
 347                 scopes: [
 348                          "https://api.curoverse.com/auth/arvados"
 349                         ]
 350               }
 351               route.segment_keys.each do |key|
 352                 if key != :format
 353                   key = :uuid if key == :id
 354                   method[:parameters][key] = {
 355                     type: "string",
 356                     description: "",
 357                     required: true,
 358                     location: "path"
 359                   }
 360                 end
 361               end
 362             else
 363               # We already built a generic method description, but we
 364               # might find some more required parameters through
 365               # introspection.
 366               method = d_methods[action.to_sym]
 367             end
 368             if ctl_class.respond_to? "_#{action}_requires_parameters".to_sym
 369               ctl_class.send("_#{action}_requires_parameters".to_sym).each do |l, v|
 370                 if v.is_a? Hash
 371                   method[:parameters][l] = v
 372                 else
 373                   method[:parameters][l] = {}
 374                 end
 375                 if !method[:parameters][l][:default].nil?
 376                   # The JAVA SDK is sensitive to all values being strings
 377                   method[:parameters][l][:default] = method[:parameters][l][:default].to_s
 378                 end
 379                 method[:parameters][l][:type] ||= 'string'
 380                 method[:parameters][l][:description] ||= ''
 381                 method[:parameters][l][:location] = (route.segment_keys.include?(l) ? 'path' : 'query')
 382                 if method[:parameters][l][:required].nil?
 383                   method[:parameters][l][:required] = v != false
 384                 end
 385               end
 386             end
 387             d_methods[action.to_sym] = method
 388
 389             if action == 'index'
 390               list_method = method.dup
 391               list_method[:id].sub!('index', 'list')
 392               list_method[:description].sub!('Index', 'List')
 393               list_method[:description].sub!('index', 'list')
 394               d_methods[:list] = list_method
 395             end
 396           end
 397         end
 398       end
 399       Rails.configuration.disable_api_methods.each do |method|
 400         ctrl, action = method.split('.', 2)
 401         discovery[:resources][ctrl][:methods].delete(action.to_sym)
 402       end
 403       discovery
 404     end
 405   end
 406 end