X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/454ee2b8f0385c542b6f1165a3baf2820425e1a3..f7bf9d69603db2d500563648460e2a96524de266:/services/api/app/controllers/arvados/v1/schema_controller.rb diff --git a/services/api/app/controllers/arvados/v1/schema_controller.rb b/services/api/app/controllers/arvados/v1/schema_controller.rb index 13e47f76cd..5508ac0fbd 100644 --- a/services/api/app/controllers/arvados/v1/schema_controller.rb +++ b/services/api/app/controllers/arvados/v1/schema_controller.rb @@ -8,6 +8,7 @@ class Arvados::V1::SchemaController < ApplicationController skip_before_action :find_object_by_uuid skip_before_action :load_filters_param skip_before_action :load_limit_offset_order_params + skip_before_action :load_select_param skip_before_action :load_read_auths skip_before_action :load_where_param skip_before_action :render_404_if_no_object @@ -26,14 +27,17 @@ class Arvados::V1::SchemaController < ApplicationController Rails.cache.fetch 'arvados_v1_rest_discovery' do Rails.application.eager_load! remoteHosts = {} - Rails.configuration.RemoteClusters.each {|k,v| if k != "*" then remoteHosts[k] = v["Host"] end } + Rails.configuration.RemoteClusters.each {|k,v| if k != :"*" then remoteHosts[k] = v["Host"] end } discovery = { kind: "discovery#restDescription", discoveryVersion: "v1", id: "arvados:v1", name: "arvados", version: "v1", - revision: "20131114", + # format is YYYYMMDD, must be fixed width (needs to be lexically + # sortable), updated manually, may be used by clients to + # determine availability of API server features. + revision: "20220222", source_version: AppVersion.hash, sourceVersion: AppVersion.hash, # source_version should be deprecated in the future packageVersion: AppVersion.package_version, @@ -53,7 +57,7 @@ class Arvados::V1::SchemaController < ApplicationController blobSignatureTtl: Rails.configuration.Collections.BlobSigningTTL, maxRequestSize: Rails.configuration.API.MaxRequestSize, maxItemsPerResponse: Rails.configuration.API.MaxItemsPerResponse, - dockerImageFormats: Rails.configuration.Containers.SupportedDockerImageFormats, + dockerImageFormats: Rails.configuration.Containers.SupportedDockerImageFormats.keys, crunchLogBytesPerEvent: Rails.configuration.Containers.Logging.LogBytesPerEvent, crunchLogSecondsBetweenEvents: Rails.configuration.Containers.Logging.LogSecondsBetweenEvents, crunchLogThrottlePeriod: Rails.configuration.Containers.Logging.LogThrottlePeriod, @@ -67,6 +71,7 @@ class Arvados::V1::SchemaController < ApplicationController remoteHostsViaDNS: Rails.configuration.RemoteClusters["*"].Proxy, websocketUrl: Rails.configuration.Services.Websocket.ExternalURL.to_s, workbenchUrl: Rails.configuration.Services.Workbench1.ExternalURL.to_s, + workbench2Url: Rails.configuration.Services.Workbench2.ExternalURL.to_s, keepWebServiceUrl: Rails.configuration.Services.WebDAV.ExternalURL.to_s, gitUrl: Rails.configuration.Services.GitHTTP.ExternalURL.to_s, parameters: { @@ -101,10 +106,10 @@ class Arvados::V1::SchemaController < ApplicationController auth: { oauth2: { scopes: { - "https://api.curoverse.com/auth/arvados" => { + "https://api.arvados.org/auth/arvados" => { description: "View and manage objects" }, - "https://api.curoverse.com/auth/arvados.readonly" => { + "https://api.arvados.org/auth/arvados.readonly" => { description: "View objects" } } @@ -216,8 +221,8 @@ class Arvados::V1::SchemaController < ApplicationController "$ref" => k.to_s }, scopes: [ - "https://api.curoverse.com/auth/arvados", - "https://api.curoverse.com/auth/arvados.readonly" + "https://api.arvados.org/auth/arvados", + "https://api.arvados.org/auth/arvados.readonly" ] }, index: { @@ -252,8 +257,8 @@ class Arvados::V1::SchemaController < ApplicationController "$ref" => "#{k.to_s}List" }, scopes: [ - "https://api.curoverse.com/auth/arvados", - "https://api.curoverse.com/auth/arvados.readonly" + "https://api.arvados.org/auth/arvados", + "https://api.arvados.org/auth/arvados.readonly" ] }, create: { @@ -274,7 +279,7 @@ class Arvados::V1::SchemaController < ApplicationController "$ref" => k.to_s }, scopes: [ - "https://api.curoverse.com/auth/arvados" + "https://api.arvados.org/auth/arvados" ] }, update: { @@ -302,7 +307,7 @@ class Arvados::V1::SchemaController < ApplicationController "$ref" => k.to_s }, scopes: [ - "https://api.curoverse.com/auth/arvados" + "https://api.arvados.org/auth/arvados" ] }, delete: { @@ -322,7 +327,7 @@ class Arvados::V1::SchemaController < ApplicationController "$ref" => k.to_s }, scopes: [ - "https://api.curoverse.com/auth/arvados" + "https://api.arvados.org/auth/arvados" ] } } @@ -349,7 +354,7 @@ class Arvados::V1::SchemaController < ApplicationController "$ref" => (action == 'index' ? "#{k.to_s}List" : k.to_s) }, scopes: [ - "https://api.curoverse.com/auth/arvados" + "https://api.arvados.org/auth/arvados" ] } route.segment_keys.each do |key| @@ -400,8 +405,86 @@ class Arvados::V1::SchemaController < ApplicationController end end end - Rails.configuration.API.DisabledAPIs.each do |method| - ctrl, action = method.split('.', 2) + + # The 'replace_files' option is implemented in lib/controller, + # not Rails -- we just need to add it here so discovery-aware + # clients know how to validate it. + [:create, :update].each do |action| + discovery[:resources]['collections'][:methods][action][:parameters]['replace_files'] = { + type: 'object', + description: 'Files and directories to initialize/replace with content from other collections.', + required: false, + location: 'query', + properties: {}, + additionalProperties: {type: 'string'}, + } + end + + discovery[:resources]['configs'] = { + methods: { + get: { + id: "arvados.configs.get", + path: "config", + httpMethod: "GET", + description: "Get public config", + parameters: { + }, + parameterOrder: [ + ], + response: { + }, + scopes: [ + "https://api.arvados.org/auth/arvados", + "https://api.arvados.org/auth/arvados.readonly" + ] + }, + } + } + + discovery[:resources]['vocabularies'] = { + methods: { + get: { + id: "arvados.vocabularies.get", + path: "vocabulary", + httpMethod: "GET", + description: "Get vocabulary definition", + parameters: { + }, + parameterOrder: [ + ], + response: { + }, + scopes: [ + "https://api.arvados.org/auth/arvados", + "https://api.arvados.org/auth/arvados.readonly" + ] + }, + } + } + + discovery[:resources]['sys'] = { + methods: { + get: { + id: "arvados.sys.trash_sweep", + path: "sys/trash_sweep", + httpMethod: "POST", + description: "apply scheduled trash and delete operations", + parameters: { + }, + parameterOrder: [ + ], + response: { + }, + scopes: [ + "https://api.arvados.org/auth/arvados", + "https://api.arvados.org/auth/arvados.readonly" + ] + }, + } + } + + Rails.configuration.API.DisabledAPIs.each do |method, _| + ctrl, action = method.to_s.split('.', 2) discovery[:resources][ctrl][:methods].delete(action.to_sym) end discovery