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

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