20259: Add documentation for banner and tooltip features
[arvados.git] / services / api / config / routes.rb
1 # Copyright (C) The Arvados Authors. All rights reserved.
2 #
3 # SPDX-License-Identifier: AGPL-3.0
4
5 Rails.application.routes.draw do
6   themes_for_rails
7
8   # OPTIONS requests are not allowed at routes that use cookies.
9   ['/auth/*a', '/login', '/logout'].each do |nono|
10     match nono, to: 'user_sessions#cross_origin_forbidden', via: 'OPTIONS'
11   end
12   # OPTIONS at discovery and API paths get an empty response with CORS headers.
13   match '/discovery/v1/*a', to: 'static#empty', via: 'OPTIONS'
14   match '/arvados/v1/*a', to: 'static#empty', via: 'OPTIONS'
15
16   namespace :arvados do
17     namespace :v1 do
18       resources :api_client_authorizations do
19         post 'create_system_auth', on: :collection
20         get 'current', on: :collection
21       end
22       resources :api_clients
23       resources :authorized_keys
24       resources :collections do
25         get 'provenance', on: :member
26         get 'used_by', on: :member
27         post 'trash', on: :member
28         post 'untrash', on: :member
29       end
30       resources :groups do
31         get 'contents', on: :collection
32         get 'contents', on: :member
33         get 'shared', on: :collection
34         post 'trash', on: :member
35         post 'untrash', on: :member
36       end
37       resources :humans
38       resources :job_tasks
39       resources :containers do
40         get 'auth', on: :member
41         post 'lock', on: :member
42         post 'unlock', on: :member
43         post 'update_priority', on: :member
44         get 'secret_mounts', on: :member
45         get 'current', on: :collection
46       end
47       resources :container_requests
48       resources :jobs do
49         get 'queue', on: :collection
50         get 'queue_size', on: :collection
51         post 'cancel', on: :member
52         post 'lock', on: :member
53       end
54       resources :keep_disks do
55         post 'ping', on: :collection
56       end
57       resources :keep_services do
58         get 'accessible', on: :collection
59       end
60       resources :links
61       resources :logs
62       resources :nodes do
63         post 'ping', on: :member
64       end
65       resources :pipeline_instances do
66         post 'cancel', on: :member
67       end
68       resources :pipeline_templates
69       resources :workflows
70       resources :repositories do
71         get 'get_all_permissions', on: :collection
72       end
73       resources :specimens
74       resources :traits
75       resources :user_agreements do
76         get 'signatures', on: :collection
77         post 'sign', on: :collection
78       end
79       resources :users do
80         get 'current', on: :collection
81         get 'system', on: :collection
82         post 'activate', on: :member
83         post 'setup', on: :collection
84         post 'unsetup', on: :member
85         post 'merge', on: :collection
86         patch 'batch_update', on: :collection
87       end
88       resources :virtual_machines do
89         get 'logins', on: :member
90         get 'get_all_logins', on: :collection
91       end
92       get '/permissions/:uuid', to: 'links#get_permissions'
93     end
94   end
95
96   post '/sys/trash_sweep', to: 'sys#trash_sweep'
97
98   if Rails.env == 'test'
99     post '/database/reset', to: 'database#reset'
100   end
101
102   # omniauth
103   match '/auth/:provider/callback', to: 'user_sessions#create', via: [:get, :post]
104   match '/auth/failure', to: 'user_sessions#failure', via: [:get, :post]
105   # not handled by omniauth provider -> 403 with no CORS headers.
106   get '/auth/*a', to: 'user_sessions#cross_origin_forbidden'
107
108   # Custom logout
109   match '/login', to: 'user_sessions#login', via: [:get, :post]
110   match '/logout', to: 'user_sessions#logout', via: [:get, :post]
111
112   match '/discovery/v1/apis/arvados/v1/rest', to: 'arvados/v1/schema#index', via: [:get, :post]
113
114   match '/static/login_failure', to: 'static#login_failure', as: :login_failure, via: [:get, :post]
115
116   match '/_health/:check', to: 'arvados/v1/management#health', via: [:get]
117   match '/metrics', to: 'arvados/v1/management#metrics', via: [:get]
118
119   # Send unroutable requests to an arbitrary controller
120   # (ends up at ApplicationController#render_not_found)
121   match '*a', to: 'static#render_not_found', via: [:get, :post, :put, :patch, :delete, :options]
122
123   root to: 'static#home'
124 end