(ns metabase.api.routes
#_{:clj-kondo/ignore [:deprecated-namespace]}
(:require
[compojure.core :refer [GET]]
[compojure.route :as route]
[metabase.api.action :as api.action]
[metabase.api.activity :as api.activity]
[metabase.api.alert :as api.alert]
[metabase.api.api-key :as api.api-key]
[metabase.api.automagic-dashboards :as api.magic]
[metabase.api.bookmark :as api.bookmark]
[metabase.api.cache :as api.cache]
[metabase.api.card :as api.card]
[metabase.api.cards :as api.cards]
[metabase.api.channel :as api.channel]
[metabase.api.cloud-migration :as api.cloud-migration]
[metabase.api.collection :as api.collection]
[metabase.api.common :as api :refer [defroutes context]]
[metabase.api.dashboard :as api.dashboard]
[metabase.api.database :as api.database]
[metabase.api.dataset :as api.dataset]
[metabase.api.email :as api.email]
[metabase.api.embed :as api.embed]
[metabase.api.field :as api.field]
[metabase.api.geojson :as api.geojson]
[metabase.api.google :as api.google]
[metabase.api.ldap :as api.ldap]
[metabase.api.login-history :as api.login-history]
[metabase.api.metabot :as api.metabot]
[metabase.api.model-index :as api.model-index]
[metabase.api.native-query-snippet :as api.native-query-snippet]
[metabase.api.notify :as api.notify]
[metabase.api.permissions :as api.permissions]
[metabase.api.persist :as api.persist]
[metabase.api.premium-features :as api.premium-features]
[metabase.api.preview-embed :as api.preview-embed]
[metabase.api.public :as api.public]
[metabase.api.pulse :as api.pulse]
[metabase.api.pulse.unsubscribe :as api.pulse.unsubscribe]
[metabase.api.revision :as api.revision]
[metabase.api.routes.common
:refer [+auth +message-only-exceptions +public-exceptions +static-apikey]]
[metabase.api.search :as api.search]
[metabase.api.segment :as api.segment]
[metabase.api.session :as api.session]
[metabase.api.setting :as api.setting]
[metabase.api.setup :as api.setup]
[metabase.api.slack :as api.slack]
[metabase.api.table :as api.table]
[metabase.api.task :as api.task]
[metabase.api.testing :as api.testing]
[metabase.api.tiles :as api.tiles]
[metabase.api.timeline :as api.timeline]
[metabase.api.timeline-event :as api.timeline-event]
[metabase.api.user :as api.user]
[metabase.api.user-key-value :as api.user-key-value]
[metabase.api.util :as api.util]
[metabase.config :as config]
[metabase.plugins.classloader :as classloader]
[metabase.util.i18n :refer [deferred-tru]]
[ring.middleware.content-type :as content-type]
[ring.util.response :as response])) | |
(when config/ee-available? (classloader/require 'metabase-enterprise.api.routes)) | |
EE routes defined in [[metabase-enterprise.api.routes/routes]] always get the first chance to handle a request, if
they exist. If they don't exist, this handler returns | (def ^:private ^{:arglists '([request respond raise])} ee-routes
;; resolve the var for every request so we pick up any changes to it in interactive development
(if-let [ee-handler-var (resolve 'metabase-enterprise.api.routes/routes)]
(with-meta
(fn [request respond raise]
((var-get ee-handler-var) request respond raise))
(meta ee-handler-var))
(fn [_request respond _raise]
(respond nil)))) |
/docs* | (api/defendpoint GET
"OpenAPI 3.1.0 JSON and UI
https://spec.openapis.org/oas/latest.html"
[:as {:keys [params uri]}]
(let [path (:* params)
respond (fn [path]
(-> (response/resource-response (str "openapi/" path))
(content-type/content-type-response {:uri path})))]
(case path
"" {:status 302
:headers {"Location" (str uri "/")}
:body ""}
"/" (-> (respond "index.html")
;; Better would be to append this to our CSP, but there is no good way right now and it's
;; just a single page. Necessary for Scalar to work, script injects styles in runtime.
(assoc-in [:headers "Content-Security-Policy"] "script-src 'self' 'unsafe-inline' https://cdn.jsdelivr.net"))
"/openapi.json" (merge
(api/openapi-object (resolve 'metabase.api.routes/routes))
{:openapi "3.1.0"
:info {:title "Metabase API"
:version (:tag config/mb-version-info)}
:servers [{:url "/api"
:description "Metabase API"}]})
(respond path)))) |
Ring routes for API endpoints. | (defroutes ^{:doc , :arglists '([request] [request respond raise])} routes
ee-routes
#'GET_docs*
(context "/action" [] (+auth api.action/routes))
(context "/activity" [] (+auth api.activity/routes))
(context "/alert" [] (+auth api.alert/routes))
(context "/automagic-dashboards" [] (+auth api.magic/routes))
(context "/bookmark" [] (+auth api.bookmark/routes))
(context "/card" [] (+auth api.card/routes))
(context "/cards" [] (+auth api.cards/routes))
(context "/cloud-migration" [] (+auth api.cloud-migration/routes))
(context "/collection" [] (+auth api.collection/routes))
(context "/channel" [] (+auth api.channel/routes))
(context "/dashboard" [] (+auth api.dashboard/routes))
(context "/database" [] (+auth api.database/routes))
(context "/dataset" [] (+auth api.dataset/routes))
(context "/email" [] (+auth api.email/routes))
(context "/embed" [] (+message-only-exceptions api.embed/routes))
(context "/field" [] (+auth api.field/routes))
(context "/geojson" [] api.geojson/routes)
(context "/google" [] (+auth api.google/routes))
(context "/ldap" [] (+auth api.ldap/routes))
(context "/login-history" [] (+auth api.login-history/routes))
(context "/metabot" [] (+auth api.metabot/routes))
(context "/model-index" [] (+auth api.model-index/routes))
(context "/native-query-snippet" [] (+auth api.native-query-snippet/routes))
(context "/notify" [] (+static-apikey api.notify/routes))
(context "/permissions" [] (+auth api.permissions/routes))
(context "/persist" [] (+auth api.persist/routes))
(context "/premium-features" [] (+auth api.premium-features/routes))
(context "/preview_embed" [] (+auth api.preview-embed/routes))
(context "/public" [] (+public-exceptions api.public/routes))
(context "/pulse/unsubscribe" [] api.pulse.unsubscribe/routes)
(context "/pulse" [] (+auth api.pulse/routes))
(context "/revision" [] (+auth api.revision/routes))
(context "/search" [] (+auth api.search/routes))
(context "/segment" [] (+auth api.segment/routes))
(context "/session" [] api.session/routes)
(context "/cache" [] (+auth api.cache/routes))
(context "/setting" [] (+auth api.setting/routes))
(context "/setup" [] api.setup/routes)
(context "/slack" [] (+auth api.slack/routes))
(context "/table" [] (+auth api.table/routes))
(context "/task" [] (+auth api.task/routes))
(context "/testing" [] (if (or (not config/is-prod?)
(config/config-bool :mb-enable-test-endpoints))
api.testing/routes
(fn [_ respond _] (respond nil))))
(context "/tiles" [] (+auth api.tiles/routes))
(context "/timeline" [] (+auth api.timeline/routes))
(context "/timeline-event" [] (+auth api.timeline-event/routes))
(context "/user" [] (+auth api.user/routes))
(context "/user-key-value" [] (+auth api.user-key-value/routes))
(context "/api-key" [] (+auth api.api-key/routes))
(context "/util" [] api.util/routes)
(route/not-found (constantly {:status 404, :body (deferred-tru "API endpoint does not exist.")}))) |