The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Add Kondo linter for defendpoint without response schema (#66294)
Cam Saulb4a13bb4c636
diff --git a/.clj-kondo/config.edn b/.clj-kondo/config.ednindex 37bc6821733..91b9995935e 100644--- a/.clj-kondo/config.edn+++ b/.clj-kondo/config.edn@@ -779,9 +779,10 @@source-namespaces{:linters- {:metabase/validate-escaped-single-quotes-in-i18n {:level :warning}- :metabase/validate-string-or-str-args-to-i18n {:level :warning}- :metabase/discourage-millis-duration {:level :warning}+ {:metabase/discourage-millis-duration {:level :warning}+ :metabase/validate-defendpoint-has-response-schema {:level :warning}+ :metabase/validate-escaped-single-quotes-in-i18n {:level :warning}+ :metabase/validate-string-or-str-args-to-i18n {:level :warning}:discouraged-var{clojure.core/with-redefs {:message "Don't use with-redefs outside of tests"}diff --git a/.clj-kondo/src/hooks/metabase/api/macros.clj b/.clj-kondo/src/hooks/metabase/api/macros.cljindex 69334858e2d..9a13610fee5 100644--- a/.clj-kondo/src/hooks/metabase/api/macros.clj+++ b/.clj-kondo/src/hooks/metabase/api/macros.clj@@ -90,6 +90,10 @@:else(recur (conj bindings x) (conj schemas nil) (list* y z more)))))](validate-route! route)+ (when-not result-schema+ (api/reg-finding! (assoc (meta node)+ :message "All REST API endpoints should have a detailed response schema"+ :type :metabase/validate-defendpoint-has-response-schema)))(let [[_route-param-schema query-param-schema _body-param-schema] schemas](when query-param-schema(validate-query-params! query-param-schema)))diff --git a/enterprise/backend/src/metabase_enterprise/action_v2/api.clj b/enterprise/backend/src/metabase_enterprise/action_v2/api.cljindex de1cefb517f..c4c85af022a 100644--- a/enterprise/backend/src/metabase_enterprise/action_v2/api.clj+++ b/enterprise/backend/src/metabase_enterprise/action_v2/api.clj@@ -127,6 +127,10 @@:else(throw (ex-info "Not able to execute given action yet" {:status-code 400 :scope scope :action action-def})))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/execute""Execute an action with a single input.@@ -158,6 +162,10 @@:user-id api/*current-user-id*}){:outputs (execute!* action scope params [input])})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/execute-bulk""Execute an action with multiple inputs.@@ -192,6 +200,10 @@:user-id api/*current-user-id*}){:outputs (execute!* action scope params inputs)})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/execute-form""Temporary endpoint for describing an actions parameterssuch that they can be presented correctly in a modal ahead of execution."diff --git a/enterprise/backend/src/metabase_enterprise/advanced_config/api/logs.clj b/enterprise/backend/src/metabase_enterprise/advanced_config/api/logs.cljindex cb52c78aafa..2a27bca5bea 100644--- a/enterprise/backend/src/metabase_enterprise/advanced_config/api/logs.clj+++ b/enterprise/backend/src/metabase_enterprise/advanced_config/api/logs.clj@@ -33,7 +33,11 @@results));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/query_execution/:yyyy-mm""Fetch rows for the month specified by `:yyyy-mm` from the query_execution logs table.Must be a superuser."diff --git a/enterprise/backend/src/metabase_enterprise/advanced_permissions/api/application.clj b/enterprise/backend/src/metabase_enterprise/advanced_permissions/api/application.cljindex 03ae458d7d5..77614721624 100644--- a/enterprise/backend/src/metabase_enterprise/advanced_permissions/api/application.clj+++ b/enterprise/backend/src/metabase_enterprise/advanced_permissions/api/application.clj@@ -1,7 +1,7 @@(ns metabase-enterprise.advanced-permissions.api.application"`/advanced-permisisons/application` Routes.- Implements the Permissions routes needed for application permission - a class of permissions that control access to features- like access Setting pages, access monitoring tools ... etc"+ Implements the Permissions routes needed for application permission - a class of permissions that control access to+ features like access Setting pages, access monitoring tools ... etc"(:require[metabase-enterprise.advanced-permissions.models.permissions.application-permissions :as a-perms][metabase.api.common :as api]@@ -11,6 +11,10 @@(set! *warn-on-reflection* true)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/graph""Fetch a graph of Application Permissions."[]@@ -34,6 +38,10 @@[graph](update graph :groups dejsonify-groups))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/graph""Do a batch update of Application Permissions by passing a modified graph."[_route-paramsdiff --git a/enterprise/backend/src/metabase_enterprise/ai_entity_analysis/api.clj b/enterprise/backend/src/metabase_enterprise/ai_entity_analysis/api.cljindex ed772adec7c..4cf9eb81266 100644--- a/enterprise/backend/src/metabase_enterprise/ai_entity_analysis/api.clj+++ b/enterprise/backend/src/metabase_enterprise/ai_entity_analysis/api.clj@@ -8,8 +8,13 @@(set! *warn-on-reflection* true)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/analyze-chart"- "Analyze a chart image using an AI vision model. This function sends the image data to a separate external AI service for analysis."+ "Analyze a chart image using an AI vision model. This function sends the image data to a separate external AI service+ for analysis."[_route-params_query-params{:keys [image_base64 name description timeline_events]} :- [:mapdiff --git a/enterprise/backend/src/metabase_enterprise/ai_sql_fixer/api.clj b/enterprise/backend/src/metabase_enterprise/ai_sql_fixer/api.cljindex 21b9df94dfe..d4fdc2a5775 100644--- a/enterprise/backend/src/metabase_enterprise/ai_sql_fixer/api.clj+++ b/enterprise/backend/src/metabase_enterprise/ai_sql_fixer/api.clj@@ -12,6 +12,10 @@(set! *warn-on-reflection* true)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/fix""Suggest fixes for a SQL query."[_route-paramsdiff --git a/enterprise/backend/src/metabase_enterprise/ai_sql_generation/api.clj b/enterprise/backend/src/metabase_enterprise/ai_sql_generation/api.cljindex d1ec5533acc..b26cd410142 100644--- a/enterprise/backend/src/metabase_enterprise/ai_sql_generation/api.clj+++ b/enterprise/backend/src/metabase_enterprise/ai_sql_generation/api.clj@@ -9,6 +9,10 @@(set! *warn-on-reflection* true)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/generate""Generate a SQL query."[_route-paramsdiff --git a/enterprise/backend/src/metabase_enterprise/audit_app/api/user.clj b/enterprise/backend/src/metabase_enterprise/audit_app/api/user.cljindex 74160e8f522..57f224388a4 100644--- a/enterprise/backend/src/metabase_enterprise/audit_app/api/user.clj+++ b/enterprise/backend/src/metabase_enterprise/audit_app/api/user.clj@@ -11,6 +11,10 @@[metabase.util.malli.schema :as ms][toucan2.core :as t2]))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/audit-info""Gets audit info for the current user if he has permissions to access the audit collection.Otherwise return an empty map."@@ -26,6 +30,10 @@{(u/slugify (:name question-overview)) (:id question-overview)(u/slugify (:name dashboard-overview)) (:id dashboard-overview)}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id/subscriptions""Delete all Alert and DashboardSubscription subscriptions for a User (i.e., so they will no longer receive them).Archive all Alerts and DashboardSubscriptions created by the User. Only allowed for admins or for the current user."diff --git a/enterprise/backend/src/metabase_enterprise/billing/api.clj b/enterprise/backend/src/metabase_enterprise/billing/api.cljindex 4829e698354..4029837ac03 100644--- a/enterprise/backend/src/metabase_enterprise/billing/api.clj+++ b/enterprise/backend/src/metabase_enterprise/billing/api.clj@@ -57,6 +57,10 @@{:name "Token expiration date" :value (valid-thru) :format "string" :display "value"}{:name "Plan" :value "Enterprise Airgap" :format "string" :display "value"}]}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Get billing information. This acts as a proxy between `metabase-billing-info-url` and the client,using the embedding token and signed in user's email to fetch the billing information."diff --git a/enterprise/backend/src/metabase_enterprise/cloud_add_ons/api.clj b/enterprise/backend/src/metabase_enterprise/cloud_add_ons/api.cljindex 7487d02ca49..1b99d903ef9 100644--- a/enterprise/backend/src/metabase_enterprise/cloud_add_ons/api.clj+++ b/enterprise/backend/src/metabase_enterprise/cloud_add_ons/api.clj@@ -63,6 +63,10 @@(:body (http/get (str url "/api/v2" endpoint) {:as :json}))(throw (ex-info (tru "Please configure store-api-url") {:status-code 400}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/plans""Get plans information from the Metabase Store API."[]@@ -78,6 +82,10 @@(log/warn e "Error fetching plans information")(handle-store-api-error e)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/addons""Get addons information from the Metabase Store API."[]@@ -93,6 +101,10 @@(log/warn e "Error fetching addons information")(handle-store-api-error e)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:product-type""Purchase an add-on."[{:keys [product-type]} :- [:mapdiff --git a/enterprise/backend/src/metabase_enterprise/comments/api.clj b/enterprise/backend/src/metabase_enterprise/comments/api.cljindex 25229d7d038..dbe69d16921 100644--- a/enterprise/backend/src/metabase_enterprise/comments/api.clj+++ b/enterprise/backend/src/metabase_enterprise/comments/api.clj@@ -90,7 +90,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Get comments for an entity"[_route-params@@ -153,6 +158,10 @@(notify-comment! (-> (t2/select-one :model/Comment :id comment-id)(t2/hydrate :creator :reactions))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new comment"[_route-params@@ -186,6 +195,10 @@:user-id api/*current-user-id*})comment))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:comment-id""Update a comment"[{:keys [comment-id]} :- [:map [:comment-id ms/PositiveInt]]@@ -220,6 +233,10 @@:user-id api/*current-user-id*})updated-comment)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:comment-id""Soft delete a comment"[{:keys [comment-id]} :- [:map [:comment-id ms/PositiveInt]]@@ -245,6 +262,10 @@;; Return 204 No Contentapi/generic-204-no-content))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:comment-id/reaction""Toggle a reaction on a comment"[{:keys [comment-id]} :- [:map [:comment-id ms/PositiveInt]]@@ -260,6 +281,10 @@(comment-reaction/toggle-reaction comment-id api/*current-user-id* emoji)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/mentions""Get a list of entities suitable for mentions. NOTE: only users for now."[_route _query _body req]diff --git a/enterprise/backend/src/metabase_enterprise/content_translation/routes.clj b/enterprise/backend/src/metabase_enterprise/content_translation/routes.cljindex 038d91eac24..30a5d7e9cc8 100644--- a/enterprise/backend/src/metabase_enterprise/content_translation/routes.clj+++ b/enterprise/backend/src/metabase_enterprise/content_translation/routes.clj@@ -26,6 +26,10 @@{:locale "ja" :msgid "Sample translation" :msgstr "サンプル翻訳"}{:locale "ko" :msgid "Sample translation" :msgstr "샘플 번역"}])+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/csv""Provides content translation dictionary in CSV"[]@@ -44,6 +48,10 @@:body (with-out-str(csv/write-csv *out* csv-data))}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post"/upload-dictionary""Upload a CSV of content translations"@@ -69,6 +77,10 @@(dictionary/read-and-import-csv! file){:success true}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/dictionary/:token""Fetch the content translation dictionary via a JSON Web Token signed with the `embedding-secret-key`."[{:keys [token]} :- [:mapdiff --git a/enterprise/backend/src/metabase_enterprise/content_verification/api/moderation_review.clj b/enterprise/backend/src/metabase_enterprise/content_verification/api/moderation_review.cljindex c30d96ed3b3..5c867e64eaf 100644--- a/enterprise/backend/src/metabase_enterprise/content_verification/api/moderation_review.clj+++ b/enterprise/backend/src/metabase_enterprise/content_verification/api/moderation_review.clj@@ -7,6 +7,10 @@[metabase.util.malli.schema :as ms][toucan2.core :as t2]))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new `ModerationReview`."[_route-paramsdiff --git a/enterprise/backend/src/metabase_enterprise/data_studio/api/table.clj b/enterprise/backend/src/metabase_enterprise/data_studio/api/table.cljindex 06acffd7da6..571a7b0e39f 100644--- a/enterprise/backend/src/metabase_enterprise/data_studio/api/table.clj+++ b/enterprise/backend/src/metabase_enterprise/data_studio/api/table.clj@@ -80,6 +80,10 @@(sync-unhidden-tables (when (and (contains? body :data_layer) (not= :copper data_layer))(filter #(= :copper (:data_layer %)) existing-tables))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/edit""Bulk updating tables."[_route-params@@ -123,6 +127,10 @@:collection_id collection-id:published_table_id id})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/publish-model""Create a model for each of selected tables"[_route-params@@ -158,6 +166,10 @@(events/publish-event! :event/table-manual-sync {:object table :user-id user-id})(quick-task/submit-task! #(database-routing/with-database-routing-off (sync/sync-table! table))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/sync-schema""Batch version of /table/:id/sync_schema. Takes an abstract table selection as /table/edit does.- Currently checks policy before returning (so you might receive a 4xx on e.g. AuthZ policy failure)@@ -180,6 +192,10 @@(sync-schema-async! table api/*current-user-id*)){:status :ok}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/rescan-values""Batch version of /table/:id/rescan_values. Takes an abstract table selection as /table/edit does."[_@@ -194,6 +210,10 @@(quick-task/submit-task! #(sync/update-field-values-for-table! table)))){:status :ok}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/discard-values""Batch version of /table/:id/discard_values. Takes an abstract table selection as /table/edit does."[_diff --git a/enterprise/backend/src/metabase_enterprise/database_replication/api.clj b/enterprise/backend/src/metabase_enterprise/database_replication/api.cljindex 2039a659e65..d53a7873013 100644--- a/enterprise/backend/src/metabase_enterprise/database_replication/api.clj+++ b/enterprise/backend/src/metabase_enterprise/database_replication/api.clj@@ -140,6 +140,10 @@[:schema-filters-type [:enum "inclusion" "exclusion" "all"]][:schema-filters-patterns :string]]]])+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/connection/:database-id/preview""Return info about pg-replication connection that is about to be created."[{:keys [database-id]} :- [:map [:database-id ms/PositiveInt]] _ {:keys [replicationSchemaFilters]} :- body-schema]@@ -148,6 +152,10 @@replication-schema-filters (m->schema-filter replicationSchemaFilters)](u/recursive-map-keys u/->camelCaseEn (preview-replication (premium-features/quotas) (preview-tables secret replication-schema-filters)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/connection/:database-id""Create a new PG replication connection for the specified database."[{:keys [database-id]} :- [:map [:database-id ms/PositiveInt]] _ {:keys [replicationSchemaFilters]} :- body-schema]@@ -175,6 +183,10 @@conn)(api/check-400 false "Not enough quota"))))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/connection/:database-id""Delete PG replication connection for the specified database."[{:keys [database-id]} :- [:map [:database-id ms/PositiveInt]]]diff --git a/enterprise/backend/src/metabase_enterprise/database_routing/api.clj b/enterprise/backend/src/metabase_enterprise/database_routing/api.cljindex dbea32600c1..c08acd81ec9 100644--- a/enterprise/backend/src/metabase_enterprise/database_routing/api.clj+++ b/enterprise/backend/src/metabase_enterprise/database_routing/api.clj@@ -13,7 +13,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/destination-database""Create new Destination Databases.@@ -87,6 +92,10 @@(t2/update! :model/DatabaseRouter :database_id db-id {:user_attribute user-attribute})(t2/insert! :model/DatabaseRouter {:database_id db-id :user_attribute user-attribute}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/router-database/:id""Updates an existing Database with the `user_attribute` to route on. Will either:- turn an existing Database into a Router databasediff --git a/enterprise/backend/src/metabase_enterprise/dependencies/api.clj b/enterprise/backend/src/metabase_enterprise/dependencies/api.cljindex 6c5bb2b832f..23bc40b35ac 100644--- a/enterprise/backend/src/metabase_enterprise/dependencies/api.clj+++ b/enterprise/backend/src/metabase_enterprise/dependencies/api.clj@@ -55,7 +55,12 @@:bad_transforms (into [] broken-transforms)}));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/check_card""Check a proposed edit to a card, and return the card IDs for those cards this edit will break."[_route-params@@ -90,7 +95,12 @@[:target {:optional true} [:maybe ms/Map]]]);; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/check_transform""Check a proposed edit to a transform, and return the card, transform, etc. IDs for things that will break."[_route-params@@ -111,7 +121,12 @@{:success true}));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/check_snippet""Check a proposed edit to a native snippet, and return the cards, etc. which will be broken."[_route-params@@ -338,6 +353,10 @@(mapv #(entity-value entity-type % usages)))))nodes-by-type)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/graph""This endpoint takes an :id and a supported entity :type, and returns a graph of all its upstream dependencies.The graph is represented by a list of :nodes and a list of :edges. Each node has an :id, :type, :data (which@@ -374,6 +393,10 @@[:question :model :metric])][:archived {:optional true} :boolean]])+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/graph/dependents""This endpoint takes an :id, :type, :dependent_type, and an optional :dependent_card_type, and returns a list ofall that entity's dependents with :dependent_type. If the :dependent_type is :card, the dependents are furtherdiff --git a/enterprise/backend/src/metabase_enterprise/documents/api/document.clj b/enterprise/backend/src/metabase_enterprise/documents/api/document.cljindex 288f4ca9371..01cc6171857 100644--- a/enterprise/backend/src/metabase_enterprise/documents/api/document.clj+++ b/enterprise/backend/src/metabase_enterprise/documents/api/document.clj@@ -139,6 +139,10 @@{:object-id id:user-id api/*current-user-id*})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Gets existing `Documents`."[_route-params@@ -148,6 +152,10 @@[:= :archived false]]}):creator :can_write :is_remote_synced)})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new `Document`."[_route-params@@ -185,11 +193,19 @@:user-id api/*current-user-id*})created-document))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:document-id""Returns an existing Document by ID."[{:keys [document-id]} :- [:map [:document-id ms/PositiveInt]]](api/read-check (get-document document-id)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:document-id""Updates an existing `Document`."[{:keys [document-id]} :- [:map@@ -233,6 +249,10 @@:user-id api/*current-user-id*}))updated-document))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:document-id""Permanently deletes an archived Document."[{:keys [document-id]} :- [:map [:document-id ms/PositiveInt]]]@@ -276,6 +296,10 @@;; Always select after update to ensure we return what's actually stored{:uuid (t2/select-one-fn :public_uuid :model/Document :id document-id)}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:document-id/public-link""Remove the public link for a Document.@@ -326,6 +350,10 @@(api/read-check document)(api/check-404 (t2/exists? :model/Card :id card-id :document_id document-id :archived false))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:document-id/card/:card-id/query/:export-format""Download query results for a Card embedded in a Document.diff --git a/enterprise/backend/src/metabase_enterprise/email/api.clj b/enterprise/backend/src/metabase_enterprise/email/api.cljindex c7775ec8b5c..cccbc4158f3 100644--- a/enterprise/backend/src/metabase_enterprise/email/api.clj+++ b/enterprise/backend/src/metabase_enterprise/email/api.clj@@ -24,6 +24,10 @@(throw (ex-info (tru "API is not available on non-hosted servers."){:status-code 402}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/override""Update multiple cloud email Settings. You must be a superuser or have `setting` permission to do this.Calling this automatically sets `cloud-smtp-enabled` to true if the settings are valid."@@ -50,6 +54,10 @@(u/prog1 (email/check-and-update-settings settings mb-to-smtp-override-settings (channel.settings/email-smtp-password-override))(when (nil? (:errors (:body <>))) (channel.settings/smtp-override-enabled! true))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/override""Clear all cloud email related settings. You must be a superuser or have `setting` permission to do this."[]diff --git a/enterprise/backend/src/metabase_enterprise/embedding_hub/api.clj b/enterprise/backend/src/metabase_enterprise/embedding_hub/api.cljindex 04d8be2f5a5..97d37b943a7 100644--- a/enterprise/backend/src/metabase_enterprise/embedding_hub/api.clj+++ b/enterprise/backend/src/metabase_enterprise/embedding_hub/api.clj@@ -61,6 +61,10 @@"embed-production" (embedding.settings/embedding-hub-production-embed-snippet-created)"secure-embeds" (has-configured-sso?)})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/checklist""Get the embedding hub checklist status, indicating which setup steps have been completed."[]diff --git a/enterprise/backend/src/metabase_enterprise/gsheets/api.clj b/enterprise/backend/src/metabase_enterprise/gsheets/api.cljindex f4a6ff54823..0689ab127d6 100644--- a/enterprise/backend/src/metabase_enterprise/gsheets/api.clj+++ b/enterprise/backend/src/metabase_enterprise/gsheets/api.clj@@ -338,6 +338,10 @@[conn-id](hm.client/make-request :put (str "/api/v2/mb/connections/" conn-id "/sync")))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/connection/sync""Force a sync of the connection now.@@ -358,6 +362,10 @@:sync_started_at (seconds-from-epoch-now))(throw-error 502 (tru "Error requesting sync") response)))))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/connection""Disconnect the google service account. There is only one (or zero) at the time of writing."[]diff --git a/enterprise/backend/src/metabase_enterprise/impersonation/api.clj b/enterprise/backend/src/metabase_enterprise/impersonation/api.cljindex 478ada25c99..5223928029b 100644--- a/enterprise/backend/src/metabase_enterprise/impersonation/api.clj+++ b/enterprise/backend/src/metabase_enterprise/impersonation/api.clj@@ -7,7 +7,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Fetch a list of all Impersonation policies currently in effect, or a single policy if both `group_id` and `db_id`are provided."@@ -20,6 +25,10 @@(t2/select-one :model/ConnectionImpersonation :group_id group_id :db_id db_id)(t2/select :model/ConnectionImpersonation {:order-by [[:id :asc]]})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id""Delete a Connection Impersonation entry."[{:keys [id]} :- [:mapdiff --git a/enterprise/backend/src/metabase_enterprise/library/api.clj b/enterprise/backend/src/metabase_enterprise/library/api.cljindex d37ad2820ac..190de66c75b 100644--- a/enterprise/backend/src/metabase_enterprise/library/api.clj+++ b/enterprise/backend/src/metabase_enterprise/library/api.clj@@ -9,6 +9,10 @@(set! *warn-on-reflection* true)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Creates the Library if it doesn't exist. Returns the created collection.@@ -32,6 +36,10 @@true sort))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Get the Library. If no library exists, it doesn't fail but returns an empty response."[_route@@ -61,6 +69,10 @@:archive-operation-id nil})]:order-by [[:%lower.name :asc]]}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/tree""This matches /api/collection/tree but only returns the library collection."[_route-paramsdiff --git a/enterprise/backend/src/metabase_enterprise/llm/api.clj b/enterprise/backend/src/metabase_enterprise/llm/api.cljindex d1f5e2a36c0..495a244ab73 100644--- a/enterprise/backend/src/metabase_enterprise/llm/api.clj+++ b/enterprise/backend/src/metabase_enterprise/llm/api.clj@@ -7,6 +7,10 @@[metabase.parameters.schema :as parameters.schema][metabase.util.malli.schema :as ms]))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/card/summarize""Summarize a question."[_route-params@@ -27,6 +31,10 @@;(check-data-permissions-for-query dataset_query){:summary (describe-question body)})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/dashboard/summarize/:id""Provide a summary of a dashboard."[{:keys [id]} :- [:mapdiff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/api.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/api.cljindex 7c018fda754..d0c13a6b1f8 100644--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/api.clj+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/api.clj@@ -71,6 +71,10 @@(store-message! conversation_id profile-id (metabot-v3.u/aisdk->messages :assistant lines)):store-in-db)})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/agent-streaming""Send a chat message to the LLM via the AI Proxy."[_route-params@@ -86,6 +90,10 @@(metabot-v3.context/log body :llm.log/fe->be)(streaming-request body))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/feedback""Proxy Metabot feedback to Harbormaster, adding the premium embedding token."[_route-paramsdiff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/api/document.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/api/document.cljindex 4c79698c8aa..cff5ae37371 100644--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/api/document.clj+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/api/document.clj@@ -33,6 +33,10 @@(catch Exception e(ex-message e))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/generate-content""Create a new piece of content to insert into the document."[_route-paramsdiff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/api/metabot.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/api/metabot.cljindex fd2a31fd43b..4c2b19c1b9f 100644--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/api/metabot.clj+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/api/metabot.clj@@ -15,18 +15,31 @@;; TODO: Eventually this should be paged but since we are just going to hardcode two models for now;; lets not+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""List configured metabot instances"[](api/check-superuser){:items (t2/select :model/Metabot {:order-by [[:name :asc]]})})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Retrieve one metabot instance"[{:keys [id]} :- [:map [:id pos-int?]]](api/check-superuser)(api/check-404 (t2/select-one :model/Metabot :id id)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update a metabot instance"[{:keys [id]} :- [:map [:id pos-int?]]@@ -52,6 +65,10 @@(metabot-v3.suggested-prompts/generate-sample-prompts id))(t2/select-one :model/Metabot :id id))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/prompt-suggestions/regenerate""Remove any existing prompt suggestions for the Metabot instance with `id` and generate new ones."[{:keys [id]} :- [:map [:id pos-int?]]]@@ -64,7 +81,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/prompt-suggestions""Return the prompt suggestions for the metabot instance with `id`."[{:keys [id]} :- [:map [:id pos-int?]]@@ -108,6 +130,10 @@:offset offset:total total}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id/prompt-suggestions""Delete all prompt suggestions for the metabot instance with `id`."[{:keys [id]} :- [:map [:id pos-int?]]]@@ -115,6 +141,10 @@(metabot-v3.suggested-prompts/delete-all-metabot-prompts id)api/generic-204-no-content)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id/prompt-suggestions/:prompt-id""Delete the prompt suggestion with ID `prompt-id` for the metabot instance with `id`."[{:keys [id prompt-id]} :- [:mapdiff --git a/enterprise/backend/src/metabase_enterprise/public_sharing/api.clj b/enterprise/backend/src/metabase_enterprise/public_sharing/api.cljindex efb99c33e0c..3a32d1e9e4b 100644--- a/enterprise/backend/src/metabase_enterprise/public_sharing/api.clj+++ b/enterprise/backend/src/metabase_enterprise/public_sharing/api.clj@@ -59,6 +59,10 @@(let [document-id (api/check-404 (t2/select-one-pk :model/Document :public_uuid uuid :archived false))](api/check-404 (t2/select-one-pk :model/Card :id card-id :document_id document-id :archived false))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/document/:uuid""Fetch a publicly-accessible Document. Does not require auth credentials. Public sharing must be enabled.@@ -73,6 +77,10 @@(events/publish-event! :event/document-read {:object-id (:id document), :user-id api/*current-user-id*})document))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/document/:uuid/card/:card-id""Run a query for a Card that's embedded in a public Document. Doesn't require auth credentials. Public sharing mustbe enabled."@@ -92,6 +100,10 @@:constraints (qp.constraints/default-query-constraints))(events/publish-event! :event/card-read {:object-id card-id :user-id api/*current-user-id* :context :question})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/document/:uuid/card/:card-id/:export-format""Fetch a Card embedded in a public Document and return query results in the specified format.Does not require auth credentials. Public sharing must be enabled."diff --git a/enterprise/backend/src/metabase_enterprise/sandbox/api/gtap.clj b/enterprise/backend/src/metabase_enterprise/sandbox/api/gtap.cljindex d3475d9d3a8..4b0e01460b8 100644--- a/enterprise/backend/src/metabase_enterprise/sandbox/api/gtap.clj+++ b/enterprise/backend/src/metabase_enterprise/sandbox/api/gtap.clj@@ -15,7 +15,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Fetch a list of all GTAPs currently in use, or a single GTAP if both `group_id` and `table_id` are provided."[_route-params@@ -26,6 +31,10 @@(t2/select-one :model/Sandbox :group_id group_id :table_id table_id)(t2/select :model/Sandbox {:order-by [[:id :asc]]})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Fetch GTAP by `id`"[{:keys [id]} :- [:map@@ -34,6 +43,10 @@;; TODO - not sure what other endpoints we might need, e.g. for fetching the list above but for a given group or Table+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new GTAP."[_route-params@@ -47,6 +60,10 @@:model/Sandbox(select-keys body [:table_id :card_id :group_id :attribute_remappings]))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update a GTAP entry. The only things you're allowed to update for a GTAP are the Card being used (`card_id`) or theparameter mappings; changing `table_id` or `group_id` would effectively be deleting this entry and creating a new@@ -66,6 +83,10 @@:present #{:card_id :attribute_remappings})))(t2/select-one :model/Sandbox :id id))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/validate""Validate a sandbox which may not have yet been saved. This runs the same validation that is performed when thesandbox is saved, but doesn't actually save the sandbox."@@ -86,6 +107,10 @@(sandbox/check-columns-match-table {:table_id table_id:card_id card_id}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id""Delete a GTAP entry."[{:keys [id]} :- [:mapdiff --git a/enterprise/backend/src/metabase_enterprise/sandbox/api/table.clj b/enterprise/backend/src/metabase_enterprise/sandbox/api/table.cljindex 4aaf8558d5a..e044bd2a00d 100644--- a/enterprise/backend/src/metabase_enterprise/sandbox/api/table.clj+++ b/enterprise/backend/src/metabase_enterprise/sandbox/api/table.clj@@ -90,8 +90,13 @@;;;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case- :metabase/validate-defendpoint-query-params-use-kebab-case]}+ :metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/query_metadata""This endpoint essentially acts as a wrapper for the OSS version of this route. When a user has sandboxed permissionsthat only gives them access to a subset of columns for a given table, those inaccessable columns should also bediff --git a/enterprise/backend/src/metabase_enterprise/sandbox/api/user.clj b/enterprise/backend/src/metabase_enterprise/sandbox/api/user.cljindex 61d9dfc82f5..4f5e3dfdc24 100644--- a/enterprise/backend/src/metabase_enterprise/sandbox/api/user.clj+++ b/enterprise/backend/src/metabase_enterprise/sandbox/api/user.clj@@ -17,6 +17,11 @@;; TODO - not sure we need this endpoint now that we're just letting you edit from the regular `PUT /api/user/:id;; endpoint+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id/attributes""Update the `login_attributes` for a User."[{:keys [id]} :- [:map@@ -29,6 +34,10 @@(def ^:private max-login-attributes 5000)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/attributes""Fetch a list of possible keys for User `login_attributes`. This just looks at keys that have already been set forexisting Users and returns those. "diff --git a/enterprise/backend/src/metabase_enterprise/scim/api.clj b/enterprise/backend/src/metabase_enterprise/scim/api.cljindex 74217d68332..25ffdaed02f 100644--- a/enterprise/backend/src/metabase_enterprise/scim/api.clj+++ b/enterprise/backend/src/metabase_enterprise/scim/api.clj@@ -38,7 +38,12 @@(assoc :unmasked_key (u.secret/expose unhashed-key))))));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/api_key""Fetch the SCIM API key if one exists. Does *not* return an unmasked key, since we don't have accessto that after it is created."@@ -47,7 +52,12 @@(api/check-404 (t2/select-one :model/ApiKey :scope :scim)));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/api_key""Create a new SCIM API key, or refresh one that already exists. When called for the first time,this is equivalent to enabling SCIM."diff --git a/enterprise/backend/src/metabase_enterprise/scim/v2/api.clj b/enterprise/backend/src/metabase_enterprise/scim/v2/api.cljindex f1c3f16c122..c313885fc10 100644--- a/enterprise/backend/src/metabase_enterprise/scim/v2/api.clj+++ b/enterprise/backend/src/metabase_enterprise/scim/v2/api.clj@@ -201,6 +201,10 @@[:= :%lower.email (u/lower-case-en match)](throw-scim-error 400 (format "Unsupported filter parameter: %s" filter-parameter)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/Users""Fetch a list of users."[_route-params@@ -230,6 +234,10 @@:Resources (map mb-user->scim hydrated-users)}](scim-response result))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get ["/Users/:id" :id #"[^/]+"]"Fetch a single user."[{:keys [id]} :- [:map@@ -239,6 +247,10 @@(t2/hydrate :scim_user_group_memberships)mb-user->scim)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/Users""Create a single user."[_route-params@@ -256,6 +268,10 @@mb-user->scim))](scim-response new-user 201)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put ["/Users/:id" :id #"[^/]+"]"Update a user."[{:keys [id]}@@ -294,6 +310,10 @@"name.familyName" (assoc acc :last_name value)(throw-scim-error 400 (format "Unsupported path: %s" path-str))))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :patch ["/Users/:id" :id #"[^/]+"]"Activate or deactivate a user. Supports specific replace operations, but not arbitrary patches."[{:keys [id]} :- [:map@@ -372,6 +392,10 @@(throw (ex-info "Unsupported filter parameter" {:filter filter-parameter:status-code 400})))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/Groups""Fetch a list of groups."[_route-params@@ -403,6 +427,10 @@:Resources (map mb-group->scim groups)}](scim-response result))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get ["/Groups/:id" :id #"[^/]+"]"Fetch a single group."[{:keys [id]} :- [:map@@ -423,6 +451,10 @@(t2/delete! :model/PermissionsGroupMembership :group_id group-id)(perms/add-users-to-groups! memberships))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/Groups""Create a single group, and populates it if necessary."[_route-params@@ -442,6 +474,10 @@mb-group->scim(scim-response 201)))))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put ["/Groups/:id" :id #"[^/]+"]"Update a group."[{:keys [id]}@@ -460,6 +496,10 @@mb-group->scimscim-response))))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete ["/Groups/:id" :id #"[^/]+"]"Delete a group."[{:keys [id]} :- [:mapdiff --git a/enterprise/backend/src/metabase_enterprise/semantic_search/api.clj b/enterprise/backend/src/metabase_enterprise/semantic_search/api.cljindex c0f3cc28c36..127137972af 100644--- a/enterprise/backend/src/metabase_enterprise/semantic_search/api.clj+++ b/enterprise/backend/src/metabase_enterprise/semantic_search/api.clj@@ -19,6 +19,10 @@(when-let [table-name (-> index-metadata :index :table-name)](semantic.index/index-size pgvector table-name)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/status""Fetch the indexing status of the currently active semantic search index table.diff --git a/enterprise/backend/src/metabase_enterprise/serialization/api.clj b/enterprise/backend/src/metabase_enterprise/serialization/api.cljindex f7df1ae2ed1..20ce59f8e9b 100644--- a/enterprise/backend/src/metabase_enterprise/serialization/api.clj+++ b/enterprise/backend/src/metabase_enterprise/serialization/api.clj@@ -159,7 +159,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/export""Serialize and retrieve Metabase instance.@@ -240,7 +245,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/import""Deserialize Metabase instance from an archive generated by /export.diff --git a/enterprise/backend/src/metabase_enterprise/sso/api/saml.clj b/enterprise/backend/src/metabase_enterprise/sso/api/saml.cljindex a303c8009b7..b0d7ca47402 100644--- a/enterprise/backend/src/metabase_enterprise/sso/api/saml.clj+++ b/enterprise/backend/src/metabase_enterprise/sso/api/saml.clj@@ -11,6 +11,10 @@(set! *warn-on-reflection* true)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/settings""Update SAML related settings. You must be a superuser to do this."[_route-paramsdiff --git a/enterprise/backend/src/metabase_enterprise/sso/api/sso.clj b/enterprise/backend/src/metabase_enterprise/sso/api/sso.cljindex 85ab25f9635..d3eae682597 100644--- a/enterprise/backend/src/metabase_enterprise/sso/api/sso.clj+++ b/enterprise/backend/src/metabase_enterprise/sso/api/sso.clj@@ -28,6 +28,11 @@metabase-enterprise.sso.integrations.saml/keep-me);; GET /auth/sso+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""SSO entry-point for an SSO user that has not logged in yet"[_route-params _query-params _body request]@@ -50,6 +55,11 @@:additionalData data}))});; POST /auth/sso+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Route the SSO backends call with successful login details"[_route-params _query-params _body request]@@ -66,6 +76,11 @@"/auth/sso/handle_slo");; POST /auth/sso/logout+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/logout""Logout."[_route-params _query-params _body {cookies :cookies, :as _request}]@@ -95,7 +110,12 @@;; POST /auth/sso/to_session;;;; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/to_session""If a user wants to simply convert a JWT to a session token (which they'll manage)this provides a path for them to do so."@@ -111,7 +131,12 @@;; POST /auth/sso/handle_slo;;;; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/handle_slo""Handles client confirmation of saml logout via slo"[_route-params _query-params _body request]diff --git a/enterprise/backend/src/metabase_enterprise/stale/api.clj b/enterprise/backend/src/metabase_enterprise/stale/api.cljindex 6913c9d7475..03db66ef28e 100644--- a/enterprise/backend/src/metabase_enterprise/stale/api.clj+++ b/enterprise/backend/src/metabase_enterprise/stale/api.clj@@ -121,7 +121,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get ["/:id" :id #"(?:\d+)|(?:root)"]"A flexible endpoint that returns stale entities, in the same shape as collections/items, with the following options:- `before_date` - only return entities that were last edited before this date (default: 6 months ago)diff --git a/enterprise/backend/src/metabase_enterprise/support_access_grants/api.clj b/enterprise/backend/src/metabase_enterprise/support_access_grants/api.cljindex 37d3688dad8..b86fd7ec78e 100644--- a/enterprise/backend/src/metabase_enterprise/support_access_grants/api.clj+++ b/enterprise/backend/src/metabase_enterprise/support_access_grants/api.clj@@ -9,6 +9,10 @@[metabase.request.core :as request][metabase.util.malli.schema :as ms]))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/":- ::grants.schema/grant-response"Create a new support access grant.@@ -24,6 +28,10 @@(:ticket_number body)(:notes body)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id/revoke":- ::grants.schema/grant-response"Revoke an existing support access grant.@@ -34,6 +42,10 @@(api/write-check :model/SupportAccessGrantLog id)(grants/revoke-grant! api/*current-user-id* id))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/":- ::grants.schema/list-grants-response"List support access grants with optional filtering and pagination.@@ -58,6 +70,10 @@:user-id user-id:include-revoked include-revoked}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/current":- ::grants.schema/current-grant-response"Get the currently active support access grant, if one exists.diff --git a/enterprise/backend/src/metabase_enterprise/transforms/api.clj b/enterprise/backend/src/metabase_enterprise/transforms/api.cljindex 11f8dbddf54..3e324a8432d 100644--- a/enterprise/backend/src/metabase_enterprise/transforms/api.clj+++ b/enterprise/backend/src/metabase_enterprise/transforms/api.clj@@ -92,7 +92,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Get a list of transforms."[_route-params@@ -103,6 +108,10 @@[:tag_ids {:optional true} [:maybe (ms/QueryVectorOf ms/IntGreaterThanOrEqualToZero)]]]](get-transforms query-params))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new transform."[_route-params@@ -146,12 +155,20 @@(u/update-some :last_run transforms.util/localize-run-timestamps)(assoc :table target-table))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Get a specific transform."[{:keys [id]} :- [:map[:id ms/PositiveInt]]](get-transform id))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/dependencies""Get the dependencies of a specific transform."[{:keys [id]} :- [:map@@ -166,7 +183,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/run""Get transform runs based on a set of filter params."[_route-params@@ -186,6 +208,10 @@:limit (request/limit)))(update :data #(map transforms.util/localize-run-timestamps %))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update a transform."[{:keys [id]} :- [:map@@ -223,6 +249,10 @@(events/publish-event! :event/transform-update {:object transform :user-id api/*current-user-id*})transform))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id""Delete a transform."[{:keys [id]} :- [:map@@ -235,6 +265,10 @@:user-id api/*current-user-id*}))nil)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id/table""Delete a transform's output table."[{:keys [id]} :- [:map@@ -243,6 +277,10 @@(transforms.util/delete-target-table-by-id! id)nil)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/cancel""Cancel the current run for a given transform."[{:keys [id]} :- [:map@@ -255,6 +293,10 @@(transforms.canceling/cancel-run! (:id run))))nil)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/run""Run a transform."[{:keys [id]} :- [:map@@ -327,6 +369,10 @@(log/debugf e "Failed to parse query: %s" (ex-message e)){:is_simple false})))+;; TODO (Cam 2025-12-04) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/is-simple-query""Checks if a native SQL query string is simple enough for automatic checkpoint insertion"[_route-params@@ -335,6 +381,10 @@(api/check-superuser)(simple-native-query? query))+;; TODO (Cam 2025-12-04) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/extract-columns""Extract column names from an MBQL query without executing it.diff --git a/enterprise/backend/src/metabase_enterprise/transforms/api/transform_job.clj b/enterprise/backend/src/metabase_enterprise/transforms/api/transform_job.cljindex 1ddc4641bd0..c3e28f591dd 100644--- a/enterprise/backend/src/metabase_enterprise/transforms/api/transform_job.clj+++ b/enterprise/backend/src/metabase_enterprise/transforms/api/transform_job.clj@@ -20,6 +20,10 @@(def ^:private ui-display-types [:cron/raw :cron/builder])+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new transform job."[_route-params@@ -59,6 +63,10 @@;; Return with hydrated tag_ids(t2/hydrate job :tag_ids)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:job-id""Update a transform job."[{:keys [job-id]} :- [:map@@ -101,6 +109,10 @@(-> (t2/select-one :model/TransformJob :id job-id)(t2/hydrate :tag_ids :last_run))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:job-id""Delete a transform job."[{:keys [job-id]} :- [:map [:job-id ms/PositiveInt]]]@@ -111,6 +123,10 @@(transforms.schedule/delete-job! job-id)api/generic-204-no-content)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:job-id/run""Run a transform job manually."[{:keys [job-id]} :- [:map [:job-id ms/PositiveInt]]]@@ -126,6 +142,10 @@{:message "Job run started":job_run_id (str "stub-" job-id "-" (System/currentTimeMillis))})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:job-id""Get a transform job by ID."[{:keys [job-id]} :- [:map@@ -141,6 +161,10 @@(assoc job :next_run {:start_time (str (transforms.util/->instant start-time))})job))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:job-id/transforms""Get the transforms of job specified by the job's ID."[{:keys [job-id]} :- [:map@@ -153,7 +177,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Get all transform jobs."[_route-paramsdiff --git a/enterprise/backend/src/metabase_enterprise/transforms/api/transform_tag.clj b/enterprise/backend/src/metabase_enterprise/transforms/api/transform_tag.cljindex 95a134610d0..6b320f6bf64 100644--- a/enterprise/backend/src/metabase_enterprise/transforms/api/transform_tag.clj+++ b/enterprise/backend/src/metabase_enterprise/transforms/api/transform_tag.clj@@ -11,6 +11,10 @@(set! *warn-on-reflection* true)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new transform tag."[_route-params@@ -23,6 +27,10 @@(deferred-tru "A tag with the name ''{0}'' already exists." name))(t2/insert-returning-instance! :model/TransformTag {:name name}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:tag-id""Update a transform tag."[{:keys [tag-id]} :- [:map@@ -38,6 +46,10 @@(t2/update! :model/TransformTag tag-id {:name name})(t2/select-one :model/TransformTag :id tag-id))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:tag-id""Delete a transform tag. Removes it from all transforms and jobs."[{:keys [tag-id]} :- [:map@@ -48,6 +60,10 @@(t2/delete! :model/TransformTag :id tag-id)api/generic-204-no-content)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Get a list of all transform tags."[_route-paramsdiff --git a/enterprise/backend/src/metabase_enterprise/transforms_python/api.clj b/enterprise/backend/src/metabase_enterprise/transforms_python/api.cljindex c41c7552c9a..3144de7928f 100644--- a/enterprise/backend/src/metabase_enterprise/transforms_python/api.clj+++ b/enterprise/backend/src/metabase_enterprise/transforms_python/api.clj@@ -22,12 +22,20 @@api/check-404(select-keys [:source :path :created_at :updated_at])))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/library/:path""Get the Python library for user modules."[{:keys [path]} :- [:map [:path :string]]_query-params](get-python-library-by-path path))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/library/:path""Update the Python library source code for user modules."[{:keys [path]} :- [:map [:path :string]]@@ -37,6 +45,10 @@(api/check-superuser)(python-library/update-python-library-source! path (:source body)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/test-run":- [:map[:logs :string]diff --git a/enterprise/backend/src/metabase_enterprise/upload_management/api.clj b/enterprise/backend/src/metabase_enterprise/upload_management/api.cljindex ea3fd193af1..5b726271321 100644--- a/enterprise/backend/src/metabase_enterprise/upload_management/api.clj+++ b/enterprise/backend/src/metabase_enterprise/upload_management/api.clj@@ -19,6 +19,10 @@(when-let [dw-tables (t2/select :model/Table :db_id dw-db-id :active true)]dw-tables))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/tables""Get all `Tables` visible to the current user which were created by uploading a file."[]@@ -28,6 +32,10 @@(map #(update % :schema str) tables)(filterv mi/can-read? tables)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/tables/:id""Delete the uploaded table from the database, optionally archiving cards for which it is the primary source."[{:keys [id]} :- [:mapdiff --git a/src/metabase/actions_rest/api.clj b/src/metabase/actions_rest/api.cljindex ebde5a8fc1e..4e204419552 100644--- a/src/metabase/actions_rest/api.clj+++ b/src/metabase/actions_rest/api.clj@@ -58,6 +58,10 @@(t2/hydrate :creator)api/read-check))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:action-id""Delete an Action."[{:keys [action-id]} :- [:map@@ -102,6 +106,10 @@;; so we return the most recently updated http action.(last (actions/select-actions nil :type action-type)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update an Action."[{:keys [id]} :- [:map@@ -120,7 +128,12 @@action));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/public_link""Generate publicly-accessible links for this Action. Returns UUID to be used in public links. (If thisAction has already been shared, it will return the existing public link rather than creating a new one.) Public@@ -138,12 +151,18 @@:made_public_by_id api/*current-user-id*})))}));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id/public_link""Delete the publicly-accessible link to this Dashboard."[{:keys [id]} :- [:map[:id ::actions.schema/id]]]- ;; check the /application/setting permission, not superuser because removing a public link is possible from /admin/settings+ ;; check the /application/setting permission, not superuser because removing a public link is possible from+ ;; /admin/settings(perms/check-has-application-permission :setting)(public-sharing.validation/check-public-sharing-enabled)(api/check-exists? :model/Action :id id, :public_uuid [:not= nil], :archived false)@@ -151,6 +170,10 @@(t2/update! :model/Action id {:public_uuid nil, :made_public_by_id nil}){:status 204, :body nil})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:action-id/execute""Fetches the values for filling in execution parameters. Pass PK parameters and values to select."[{:keys [action-id]} :- [:map@@ -162,6 +185,10 @@api/read-check(actions/fetch-values (json/decode parameters))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/execute""Execute the Action.diff --git a/src/metabase/activity_feed/api.clj b/src/metabase/activity_feed/api.cljindex e5e2c38ad44..9656d12d635 100644--- a/src/metabase/activity_feed/api.clj+++ b/src/metabase/activity_feed/api.clj@@ -111,7 +111,12 @@(def ^:private card-runs-limit 8);; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/recent_views""Get a list of 100 models (cards, models, tables, dashboards, and collections) that the current user has been viewing mostrecently. Return a maximum of 20 model of each, if they've looked at at least 20."@@ -121,7 +126,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/recents""Get a list of recent items the current user has been viewing most recently under the `:recents` key.Allows for filtering by context: views or selections"@@ -132,6 +142,10 @@(when-not (seq context) (throw (ex-info "context is required." {})))(recent-views/get-recents *current-user-id* context {:include-metadata? include_metadata}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/recents""Adds a model to the list of recently selected items."[_route-params@@ -148,7 +162,12 @@(recent-views/update-users-recent-views! *current-user-id* model-type model-id context)));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/most_recently_viewed_dashboard""Get the most recently viewed dashboard for the current user. Returns a 204 if the user has not viewed any dashboardsin the last 24 hours."@@ -246,7 +265,12 @@recent-views/fill-recent-view-info)))));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/popular_items""Get the list of 5 popular things on the instance. Query takes 8 and limits to 5 so that if it finds anythingarchived, deleted, etc it can usually still get 5. "diff --git a/src/metabase/analytics/api.clj b/src/metabase/analytics/api.cljindex a9bcc7361c2..8ddc6b267d5 100644--- a/src/metabase/analytics/api.clj+++ b/src/metabase/analytics/api.clj@@ -4,7 +4,12 @@[metabase.api.macros :as api.macros][metabase.permissions.core :as perms]))-;;; I don't think this endpoint is actually used anywhere for anything.+;; I don't think this endpoint is actually used anywhere for anything.+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/anonymous-stats""Anonymous usage stats. Endpoint for testing, and eventually exposing this to instance admins to let them seewhat is being phoned home."diff --git a/src/metabase/api/util.clj b/src/metabase/api/util.cljindex 1e4ea086418..64f3481d86b 100644--- a/src/metabase/api/util.clj+++ b/src/metabase/api/util.clj@@ -8,7 +8,12 @@(set! *warn-on-reflection* true);; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/random_token""Return a cryptographically secure random 32-byte token, encoded as a hexadecimal string.Intended for use when creating a value for `embedding-secret-key`."diff --git a/src/metabase/api_keys/api.clj b/src/metabase/api_keys/api.cljindex d13ee3964c8..979fdd33e1f 100644--- a/src/metabase/api_keys/api.clj+++ b/src/metabase/api_keys/api.clj@@ -32,6 +32,10 @@(maybe-expose-key)(update :updated_by #(select-keys % [:common_name :id]))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new API key (and an associated `User`) with the provided name and group ID."[_route-params@@ -43,12 +47,20 @@(-> (api-key/create-api-key-with-new-user! {:key-name key-name, :group-id group-id})present-api-key))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/count""Get the count of API keys in the DB with the default scope."[](api/check-superuser)(t2/count :model/ApiKey :scope nil))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update an API key by changing its group and/or its name"[{:keys [id]} :- [:map@@ -80,6 +92,10 @@:masked_key (:masked-key regenerated):prefix (:prefix regenerated)}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Get a list of API keys with the default scope. Non-paginated."[]@@ -87,6 +103,10 @@(let [api-keys (t2/hydrate (t2/select :model/ApiKey :scope nil) :group :updated_by)](map present-api-key api-keys)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id""Delete an ApiKey"[{:keys [id]} :- [:mapdiff --git a/src/metabase/bookmarks/api.clj b/src/metabase/bookmarks/api.cljindex a7f9c3b6e5d..89059e24945 100644--- a/src/metabase/bookmarks/api.clj+++ b/src/metabase/bookmarks/api.clj@@ -31,6 +31,10 @@"collection" [:model/Collection :model/CollectionBookmark :collection_id]"document" [:model/Document :model/DocumentBookmark :document_id]})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Fetch all bookmarks for the user"[]@@ -38,6 +42,10 @@;; below(bookmark/bookmarks-for-user api/*current-user-id*))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:model/:id""Create a new bookmark for user."[{:keys [model id]} :- [:map@@ -52,6 +60,10 @@[400 "Bookmark already exists"])(first (t2/insert-returning-instances! bookmark-model {item-key id :user_id api/*current-user-id*}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:model/:id""Delete a bookmark. Will delete a bookmark assigned to the user making the request by model and id."[{:keys [model id]} :- [:map@@ -66,6 +78,10 @@item-key id)api/generic-204-no-content))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/ordering""Sets the order of bookmarks for user."[_route-paramsdiff --git a/src/metabase/bug_reporting/api.clj b/src/metabase/bug_reporting/api.cljindex 4dce25ef9bf..ec05bca6828 100644--- a/src/metabase/bug_reporting/api.clj+++ b/src/metabase/bug_reporting/api.clj@@ -37,6 +37,10 @@:current-user-count (premium-features/active-users-count):valid-thru (:valid-thru (premium-features/token-status))})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/details""Returns version and system information relevant to filing a bug report against Metabase."[]@@ -45,6 +49,10 @@(not (premium-features/is-hosted?))(assoc :system-info (u.system-info/system-info))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/connection-pool-details""Returns database connection pool info for the current Metabase instance."[]diff --git a/src/metabase/cache/api.clj b/src/metabase/cache/api.cljindex 539147edbfb..415e3f98f6c 100644--- a/src/metabase/cache/api.clj+++ b/src/metabase/cache/api.clj@@ -109,6 +109,10 @@"question" :model/Card)id)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Return cache configuration."[_route-params@@ -126,6 +130,10 @@(check-cache-access (first model) id){:data (cache-config/get-list model collection id)})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/""Store cache configuration."[_route-params@@ -138,6 +146,10 @@(check-cache-access model model_id){:id (cache-config/store! api/*current-user-id* config)})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/""Delete cache configurations."[_route-params@@ -150,6 +162,10 @@(cache-config/delete! api/*current-user-id* model model_id)nil)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/invalidate""Invalidate cache entries.diff --git a/src/metabase/channel/api/channel.clj b/src/metabase/channel/api/channel.cljindex 1afa2ca92d8..d12cc966866 100644--- a/src/metabase/channel/api/channel.clj+++ b/src/metabase/channel/api/channel.clj@@ -22,6 +22,10 @@channel(dissoc channel :details)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Get all channels"[_route-params@@ -40,6 +44,10 @@#(= "channel" (namespace (keyword %)))](deferred-tru "Must be a namespaced channel. E.g: channel/http")))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a channel"[_route-params@@ -57,12 +65,20 @@(u/prog1 (t2/insert-returning-instance! :model/Channel body)(events/publish-event! :event/channel-create {:object <> :user-id api/*current-user-id*})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Get a channel"[{:keys [id]} :- [:map[:id ms/PositiveInt]]](-> (t2/select-one :model/Channel id) api/read-check remove-details-if-needed))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update a channel"[{:keys [id]} :- [:map@@ -96,6 +112,10 @@:body {:message (ex-message e):data (ex-data e)}})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/test""Test a channel connection"[_route-paramsdiff --git a/src/metabase/channel/api/email.clj b/src/metabase/channel/api/email.cljindex 2e1ed0eef14..fc9de5a8178 100644--- a/src/metabase/channel/api/email.clj+++ b/src/metabase/channel/api/email.clj@@ -17,6 +17,10 @@:email-smtp-port :port:email-smtp-security :security})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/""Update multiple email Settings. You must be a superuser or have `setting` permission to do this."[_route-params@@ -29,6 +33,10 @@[:email-smtp-username {:optional true} [:or string? nil?]]]](email/check-and-update-settings settings mb-to-smtp-settings (channel.settings/email-smtp-password)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/""Clear all email related settings. You must be a superuser or have `setting` permission to do this."[]@@ -36,6 +44,10 @@(setting/set-many! (zipmap (keys mb-to-smtp-settings) (repeat nil)))api/generic-204-no-content)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/test""Send a test email using the SMTP Settings. You must be a superuser or have `setting` permission to do this.Returns `{:ok true}` if we were able to send the message successfully, otherwise a standard 400 error response."diff --git a/src/metabase/channel/api/slack.clj b/src/metabase/channel/api/slack.cljindex c4a80898ce3..fd061f25e6b 100644--- a/src/metabase/channel/api/slack.clj+++ b/src/metabase/channel/api/slack.clj@@ -76,6 +76,10 @@:emoji true}:url file-url}]}]))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/settings""Update Slack related settings. You must be a superuser to do this. Also updates the slack-cache.There are 3 cases where we alter the slack channel/user cache:@@ -125,6 +129,10 @@(def ^:private slack-manifest(delay (slurp (io/resource "slack-manifest.yaml"))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/manifest""Returns the YAML manifest file that should be used to bootstrap new Slack apps"[]@@ -132,6 +140,11 @@@slack-manifest);; Handle bug report submissions to Slack+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/bug-report""Send diagnostic information to the configured Slack channels."[_route-paramsdiff --git a/src/metabase/cloud_migration/api.clj b/src/metabase/cloud_migration/api.cljindex 95a83771e7b..ac8ba5fad9b 100644--- a/src/metabase/cloud_migration/api.clj+++ b/src/metabase/cloud_migration/api.clj@@ -11,6 +11,10 @@[metabase.premium-features.core :as premium-features][toucan2.core :as t2]))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Initiate a new cloud migration."[]@@ -34,12 +38,20 @@400 {:status 400 :body "Cannot migrate this Metabase version."}{:status 500 :body ""})))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Get the latest cloud migration, if any."[](api/check-superuser)(t2/select-one :model/CloudMigration {:order-by [[:created_at :desc]]}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/cancel""Cancel any ongoing cloud migrations, if any."[]diff --git a/src/metabase/collections_rest/api.clj b/src/metabase/collections_rest/api.cljindex b3a42cb2d16..65170402a73 100644--- a/src/metabase/collections_rest/api.clj+++ b/src/metabase/collections_rest/api.clj@@ -122,6 +122,10 @@exclude-other-user-collections(remove-other-users-personal-subcollections api/*current-user-id*)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Fetch a list of all Collections that the current user has read permissions for (`:can_write` is returned as anadditional property of each Collection so you can tell which of these you have write permissions for.)@@ -179,6 +183,10 @@(collection/collections->tree nil)(map (fn [coll] (update coll :children #(boolean (seq %)))))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/tree""Similar to `GET /`, but returns Collections in a tree structure, e.g.@@ -1010,6 +1018,10 @@:can_restore:can_delete)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/trash""Fetch the trash collection, as in `/api/collection/:trash-id`"[]@@ -1127,6 +1139,10 @@(defn- root-collection [collection-namespace](collection-detail (collection/root-collection-with-ui-details collection-namespace)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/root""Return the 'Root' Collection object with standard details added"[_route-params@@ -1150,7 +1166,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/root/items""Fetch objects that the current user should see at their root level. As mentioned elsewhere, the 'Root' Collectiondoesn't actually exist as a row in the application DB: it's simply a virtual Collection where things with no@@ -1248,6 +1269,10 @@(events/publish-event! :event/collection-create {:object <> :user-id api/*current-user-id*}))(events/publish-event! :event/collection-touch {:collection-id (:id <>) :user-id api/*current-user-id*}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new Collection."[_route-params@@ -1321,6 +1346,10 @@;;; ------------------------------------------------ GRAPH ENDPOINTS -------------------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/graph""Fetch a graph of all Collection Permissions."[_route-params@@ -1372,6 +1401,10 @@{:revision (perms/latest-collection-permissions-revision-id)}(perms/graph namespace)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/graph""Do a batch update of Collections Permissions by passing in a modified graph. Will overwrite parts of the graph thatare present in the request, and leave the rest unchanged.@@ -1397,6 +1430,10 @@;;; ------------------------------------------ Fetching a single Collection -------------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Fetch a specific Collection with standard details added"[{:keys [id]} :- [:map@@ -1404,6 +1441,10 @@(let [resolved-id (eid-translation/->id-or-404 :collection id)](collection-detail (api/read-check :model/Collection resolved-id))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Modify an existing Collection, including archiving or unarchiving it, or moving it."[{:keys [id]} :- [:map@@ -1437,6 +1478,10 @@;; finally, return the updated object(collection-detail (t2/select-one :model/Collection :id id)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id""Deletes a collection permanently"[{:keys [id]} :- [:map@@ -1463,7 +1508,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/items""Fetch a specific Collection's items with the following options:diff --git a/src/metabase/dashboards_rest/api.clj b/src/metabase/dashboards_rest/api.cljindex c0cf02cfd51..491d03972fb 100644--- a/src/metabase/dashboards_rest/api.clj+++ b/src/metabase/dashboards_rest/api.clj@@ -67,6 +67,10 @@(t2/hydrate <> :creator)(filter mi/can-read? <>)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""This endpoint is currently unused by the Metabase frontend and may be out of date with the rest of the application.It only exists for backwards compatibility and may be removed in the future.@@ -116,6 +120,10 @@(dashboards.settings/dashboards-save-last-used-parameters) (cons :last_used_param_values)true (apply t2/hydrate dashboard)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new Dashboard."[_route-params@@ -484,6 +492,10 @@update-colvalmap-setting id->new-card)))))dashcards)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:from-dashboard-id/copy""Copy a Dashboard."[{:keys [from-dashboard-id]} :- [:map@@ -549,6 +561,10 @@;;; --------------------------------------------- List public and embeddable dashboards ------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/public""Fetch a list of Dashboards with public UUIDs. These dashboards are publicly-accessible *if* public sharing isenabled."@@ -557,6 +573,10 @@(public-sharing.validation/check-public-sharing-enabled)(t2/select [:model/Dashboard :name :id :public_uuid], :public_uuid [:not= nil], :archived false))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/embeddable""Fetch a list of Dashboards where `enable_embedding` is `true`. The dashboards can be embedded using the embeddingendpoints and a signed JWT."@@ -567,6 +587,10 @@;;; --------------------------------------------- Fetching/Updating/Etc. ---------------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Get Dashboard with ID."[{:keys [id]} :- [:map@@ -578,6 +602,10 @@(u/prog1 (first (revisions/with-last-edit-info [dashboard] :dashboard))(events/publish-event! :event/dashboard-read {:object-id (:id dashboard) :user-id api/*current-user-id*})))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/items""Get Dashboard with ID."[{:keys [id]} :- [:map@@ -631,6 +659,10 @@(embedding.validation/check-embedding-enabled)(api/check-superuser)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id""Hard delete a Dashboard. To soft delete, use `PUT /api/dashboard/:id`@@ -1017,6 +1049,10 @@[:dashcards {:optional true} [:maybe (ms/maps-with-unique-key [:sequential UpdatedDashboardCard] :id)]][:tabs {:optional true} [:maybe (ms/maps-with-unique-key [:sequential UpdatedDashboardTab] :id)]]])+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update a Dashboard, and optionally the `dashcards` and `tabs` of a Dashboard. The request body should be a JSON object with the samestructure as the response from `GET /api/dashboard/:id`."@@ -1026,6 +1062,10 @@dash-updates :- DashUpdates](update-dashboard! id dash-updates))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id/cards""(DEPRECATED -- Use the `PUT /api/dashboard/:id` endpoint instead.)Update `Cards` and `Tabs` on a Dashboard. Request body should have the form:@@ -1054,7 +1094,12 @@:tabs (:tabs dashboard)}));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/query_metadata""Get all of the required query metadata for the cards on dashboard."[{:keys [id]} :- [:map@@ -1069,7 +1114,12 @@;;; ----------------------------------------------- Sharing is Caring ------------------------------------------------;; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:dashboard-id/public_link""Generate publicly-accessible links for this Dashboard. Returns UUID to be used in public links. (If thisDashboard has already been shared, it will return the existing public link rather than creating a new one.) Public@@ -1086,7 +1136,12 @@:made_public_by_id api/*current-user-id*})))});; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:dashboard-id/public_link""Delete the publicly-accessible link to this Dashboard."[{:keys [dashboard-id]} :- [:map@@ -1099,6 +1154,10 @@:made_public_by_id nil}){:status 204, :body nil})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/related""Return related entities."[{:keys [id]} :- [:map@@ -1107,6 +1166,10 @@;;; ---------------------------------------------- Transient dashboards ----------------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/save/collection/:parent-collection-id""Save a denormalized description of dashboard into collection with ID `:parent-collection-id`."[{:keys [parent-collection-id]} :- [:map@@ -1118,6 +1181,10 @@(events/publish-event! :event/dashboard-create {:object dashboard :user-id api/*current-user-id*})dashboard))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/save""Save a denormalized description of dashboard."[_route-params@@ -1134,6 +1201,10 @@;;; ------------------------------------- Chain-filtering param value endpoints --------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/params/:param-key/values""Fetch possible values of the parameter whose ID is `:param-key`. If the values come directly from a query, optionallyrestrict these values by passing query parameters like `other-parameter=value` e.g.@@ -1149,6 +1220,10 @@(binding [qp.perms/*param-values-query* true](parameters.dashboard/param-values dashboard param-key constraint-param-key->value)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/params/:param-key/search/:query""Fetch possible values of the parameter whose ID is `:param-key` that contain `:query`. Optionally restrictthese values by passing query parameters like `other-parameter=value` e.g.@@ -1169,6 +1244,10 @@chain-filter/*allow-implicit-uuid-field-remapping* false](parameters.dashboard/param-values dashboard param-key constraint-param-key->value query)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/params/:param-key/remapping""Fetch the remapped value for a given value of the parameter with ID `:param-key`.@@ -1182,6 +1261,10 @@(binding [qp.perms/*param-values-query* true](parameters.dashboard/dashboard-param-remapped-value dashboard param-key (codec/url-decode value)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/params/valid-filter-fields""Utility endpoint for powering Dashboard UI. Given some set of `filtered` Field IDs (presumably Fields used inparameters) and a set of `filtering` Field IDs that will be used to restrict values of `filtered` Fields, for each@@ -1227,6 +1310,10 @@;;; ---------------------------------- Executing the action associated with a Dashcard -------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:dashboard-id/dashcard/:dashcard-id/execute""Fetches the values for filling in execution parameters. Pass PK parameters and values to select."[{:keys [dashboard-id dashcard-id]} :- [:map@@ -1239,6 +1326,10 @@(api/check-404 (actions/dashcard->action dashcard-id))(json/decode parameters)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:dashboard-id/dashcard/:dashcard-id/execute""Execute the associated Action in the context of a `Dashboard` and `DashboardCard` that includes it.@@ -1256,6 +1347,10 @@;;; ---------------------------------- Running the query associated with a Dashcard ----------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:dashboard-id/dashcard/:dashcard-id/card/:card-id/query""Run the query associated with a Saved Question (`Card`) in the context of a `Dashboard` that includes it."[{:keys [dashboard-id dashcard-id card-id]} :- [:map@@ -1274,6 +1369,10 @@:card-id card-id:dashcard-id dashcard-id}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:dashboard-id/dashcard/:dashcard-id/card/:card-id/query/:export-format""Run the query associated with a Saved Question (`Card`) in the context of a `Dashboard` that includes it, and returnits results as a file in the specified format.@@ -1316,6 +1415,10 @@:pivot? pivot-results?:js-int-to-string? false}}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/pivot/:dashboard-id/dashcard/:dashcard-id/card/:card-id/query""Run a pivot table query for a specific DashCard."[{:keys [dashboard-id dashcard-id card-id]} :- [:mapdiff --git a/src/metabase/eid_translation/api.clj b/src/metabase/eid_translation/api.cljindex 6056e287a53..e35ff3860f3 100644--- a/src/metabase/eid_translation/api.clj+++ b/src/metabase/eid_translation/api.clj@@ -7,6 +7,10 @@;;; endpoints in this namespace are not currently gated with `+auth` or whatever -- meaning they are public facing --;;; keep this in mind!+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/translate""Translate entity IDs to model IDs."[_route-paramsdiff --git a/src/metabase/embedding_rest/api/embed.clj b/src/metabase/embedding_rest/api/embed.cljindex fde9d9ae861..a636aa9ce53 100644--- a/src/metabase/embedding_rest/api/embed.clj+++ b/src/metabase/embedding_rest/api/embed.clj@@ -65,6 +65,10 @@;;; ------------------------------------------- /api/embed/card endpoints --------------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/card/:token""Fetch a Card via a JSON Web Token signed with the `embedding-secret-key`.@@ -96,6 +100,10 @@:constraints constraints:options options)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/card/:token/query""Fetch the results of running a Card using a JSON Web Token signed with the `embedding-secret-key`.@@ -110,7 +118,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get ["/card/:token/query/:export-format", :export-format qp.schema/export-formats-regex]"Like `GET /api/embed/card/query`, but returns the results as a file in the specified format."[{:keys [token export-format]} :- [:map@@ -133,6 +146,10 @@;;; ----------------------------------------- /api/embed/dashboard endpoints -----------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/dashboard/:token""Fetch a Dashboard via a JSON Web Token signed with the `embedding-secret-key`.@@ -177,6 +194,10 @@:qp qp:middleware middleware)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/dashboard/:token/dashcard/:dashcard-id/card/:card-id""Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the`embedding-secret-key`"@@ -196,7 +217,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get ["/dashboard/:token/dashcard/:dashcard-id/card/:card-id/:export-format":export-format qp.schema/export-formats-regex]"Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the@@ -229,6 +255,10 @@;; variables whose name includes `id-` e.g. `id-query-params` below are ones that are keyed by ID; ones whose name;; includes `slug-` are keyed by slug.+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/dashboard/:token/params/:param-key/values""Embedded version of chain filter values endpoint."[{:keys [token param-key]} :- [:map@@ -238,6 +268,10 @@(api.embed.common/dashboard-param-values token param-key nil(api.embed.common/parse-query-params query-params)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/dashboard/:token/params/:param-key/search/:prefix""Embedded version of chain filter search endpoint."[{:keys [token param-key prefix]}@@ -245,12 +279,20 @@(api.embed.common/dashboard-param-values token param-key prefix(api.embed.common/parse-query-params query-params)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/dashboard/:token/params/:param-key/remapping""Embedded version of the remapped dashboard param value endpoint."[{:keys [token param-key]}{:keys [value]}](api.embed.common/dashboard-param-remapped-value token param-key (codec/url-decode value)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/card/:token/params/:param-key/values""Embedded version of api.card filter values endpoint."[{:keys [token param-key]} :- [:map@@ -264,6 +306,10 @@:card card:param-key param-key})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/card/:token/params/:param-key/search/:prefix""Embedded version of chain filter search endpoint."[{:keys [token param-key prefix]}] :- [:map@@ -279,6 +325,10 @@:param-key param-key:search-prefix prefix})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/card/:token/params/:param-key/remapping""Embedded version of api.card filter values endpoint."[{:keys [token param-key]} :- [:map@@ -294,6 +344,10 @@:param-key param-key:value (codec/url-decode value)})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/pivot/card/:token/query""Fetch the results of running a Card using a JSON Web Token signed with the `embedding-secret-key`.@@ -308,6 +362,10 @@:api (api.embed.common/parse-query-params query-params):qp qp.pivot/run-pivot-query))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/pivot/dashboard/:token/dashcard/:dashcard-id/card/:card-id""Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the`embedding-secret-key`"@@ -320,6 +378,10 @@:api (api.embed.common/parse-query-params query-params):qp qp.pivot/run-pivot-query))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/tiles/card/:token/:zoom/:x/:y""Generates a single tile image for an embedded Card using the map visualization."[{:keys [token zoom x y]}@@ -342,6 +404,10 @@(request/as-admin(api.tiles/process-tiles-query-for-card card-id parameters zoom x y lat-field lon-field))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/tiles/dashboard/:token/dashcard/:dashcard-id/card/:card-id/:zoom/:x/:y""Generates a single tile image for a Card on an embedded Dashboard using the map visualization."[{:keys [token dashcard-id card-id zoom x y]}diff --git a/src/metabase/embedding_rest/api/preview_embed.clj b/src/metabase/embedding_rest/api/preview_embed.cljindex da572fc5d7c..de16357b25c 100644--- a/src/metabase/embedding_rest/api/preview_embed.clj+++ b/src/metabase/embedding_rest/api/preview_embed.clj@@ -26,6 +26,10 @@(embedding.validation/check-embedding-enabled)(embed/unsign token))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/card/:token""Fetch a Card you're considering embedding by passing a JWT `token`."[{:keys [token]} :- [:map@@ -38,6 +42,10 @@"Embedding previews need to be limited in size to avoid performance issues (#20938)."2000)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/card/:token/query""Fetch the query results for a Card you're considering embedding by passing a JWT `token`."[{:keys [token]} :- [:map@@ -53,6 +61,10 @@:constraints {:max-results max-results}:query-params (api.embed.common/parse-query-params query-params))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/card/:token/params/:param-key/remapping""Embedded version of api.card filter values endpoint."[{:keys [token param-key]} :- [:map@@ -68,6 +80,10 @@:param-key param-key:value (codec/url-decode value)})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/dashboard/:token""Fetch a Dashboard you're considering embedding by passing a JWT `token`. "[{:keys [token]} :- [:map@@ -76,6 +92,10 @@(api.embed.common/dashboard-for-unsigned-token unsigned-token:embedding-params (embed/get-in-unsigned-token-or-throw unsigned-token [:_embedding_params]))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/dashboard/:token/params/:param-key/values""Embedded version of chain filter values endpoint."[{:keys [token param-key]}@@ -86,6 +106,10 @@(api.embed.common/parse-query-params query-params){:preview true}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/dashboard/:token/params/:param-key/search/:prefix""Embedded version of chain filter search endpoint."[{:keys [token param-key prefix]}@@ -96,12 +120,20 @@(api.embed.common/parse-query-params query-params){:preview true}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/dashboard/:token/params/:param-key/remapping""Embedded version of the remapped dashboard param value endpoint."[{:keys [token param-key]}{:keys [value]}](api.embed.common/dashboard-param-remapped-value token param-key (codec/url-decode value) {:preview true}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/dashboard/:token/dashcard/:dashcard-id/card/:card-id""Fetch the results of running a Card belonging to a Dashboard you're considering embedding with JWT `token`."[{:keys [token dashcard-id card-id]} :- [:map@@ -122,6 +154,10 @@:token-params token-params:query-params (api.embed.common/parse-query-params query-params))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/pivot/card/:token/query""Fetch the query results for a Card you're considering embedding by passing a JWT `token`."[{:keys [token]} :- [:map@@ -137,6 +173,10 @@:query-params (api.embed.common/parse-query-params query-params):qp qp.pivot/run-pivot-query)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/pivot/dashboard/:token/dashcard/:dashcard-id/card/:card-id""Fetch the results of running a Card belonging to a Dashboard you're considering embedding with JWT `token`."[{:keys [token dashcard-id card-id]} :- [:map@@ -158,6 +198,10 @@:query-params (api.embed.common/parse-query-params query-params):qp qp.pivot/run-pivot-query)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/tiles/card/:token/:zoom/:x/:y""Generates a single tile image for an embedded Card using the map visualization."[{:keys [token zoom x y]}@@ -179,6 +223,10 @@(request/as-admin(api.tiles/process-tiles-query-for-card card-id parameters zoom x y lat-field lon-field))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/tiles/dashboard/:token/dashcard/:dashcard-id/card/:card-id/:zoom/:x/:y""Generates a single tile image for a Card on an embedded Dashboard using the map visualization."[{:keys [token dashcard-id card-id zoom x y]}diff --git a/src/metabase/geojson/api.clj b/src/metabase/geojson/api.cljindex 2335eca2083..898ffec6216 100644--- a/src/metabase/geojson/api.clj+++ b/src/metabase/geojson/api.clj@@ -76,6 +76,10 @@(respond (-> (response/response is)(response/content-type "application/json")))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:key""Fetch a custom GeoJSON file as defined in the [[metabase.geojson.settings/custom-geojson]] setting. (This just actsas a simple proxy for the file specified for `key`)."@@ -95,6 +99,10 @@(raise e)))(raise (ex-info (tru "Invalid custom GeoJSON key: {0}" k) {:status-code 400}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Load a custom GeoJSON file based on a URL or file path provided as a query parameter.This behaves similarly to /api/geojson/:key but doesn't require the custom map to be saved to the DB first."diff --git a/src/metabase/glossary/api.clj b/src/metabase/glossary/api.cljindex 0a77f31156e..72c9ac50a4c 100644--- a/src/metabase/glossary/api.clj+++ b/src/metabase/glossary/api.clj@@ -7,6 +7,10 @@[metabase.util.malli.schema :as ms][toucan2.core :as t2]))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Fetch all glossary entries, optionally filtered by search term."[_route-params@@ -19,6 +23,10 @@where (assoc :where where))):creator)}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new glossary entry."[_route-params@@ -35,6 +43,10 @@:user-id api/*current-user-id*})(t2/hydrate glossary :creator)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update an existing glossary entry."[{:keys [id]} :- [:map [:id ms/PositiveInt]]@@ -51,6 +63,10 @@:user-id api/*current-user-id*})(t2/hydrate glossary :creator))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id""Delete a glossary entry."[{:keys [id]} :- [:map [:id ms/PositiveInt]]]diff --git a/src/metabase/indexed_entities/api.clj b/src/metabase/indexed_entities/api.cljindex e2cc4786378..27f81dbf886 100644--- a/src/metabase/indexed_entities/api.clj+++ b/src/metabase/indexed_entities/api.clj@@ -33,6 +33,10 @@:ref ref:fields metadata}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create ModelIndex."[_route-params@@ -63,7 +67,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Retrieve list of ModelIndex."[_route-params@@ -76,6 +85,10 @@:status-code 400})))(t2/select :model/ModelIndex :model_id model_id)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Retrieve ModelIndex."[{:keys [id]} :- [:map@@ -88,6 +101,10 @@:status-code 400})))model-index))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id""Delete ModelIndex."[{:keys [id]} :- [:mapdiff --git a/src/metabase/logger/api.clj b/src/metabase/logger/api.cljindex ca8a15fa8bd..eebb13f053e 100644--- a/src/metabase/logger/api.clj+++ b/src/metabase/logger/api.clj@@ -18,6 +18,10 @@(set! *warn-on-reflection* true)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/logs""Logs."[]@@ -185,6 +189,10 @@:microseconds (quot value (long 1e6)):nanoeconds (quot value (long 1e9)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/adjustment""Temporarily adjust the log levels."[_route-params@@ -224,6 +232,10 @@(reset! log-adjustment {:plan plan, :undo-task (undo-task plan duration duration_unit)})))nil)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/adjustment""Undo any log level adjustments."[]diff --git a/src/metabase/login_history/api.clj b/src/metabase/login_history/api.cljindex 2c50ba99ce1..c4b1a7d3af9 100644--- a/src/metabase/login_history/api.clj+++ b/src/metabase/login_history/api.clj@@ -17,6 +17,10 @@:user_id (u/the-id user-or-id){:order-by [[:timestamp :desc]]})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/current""Fetch recent logins for the current user."[]diff --git a/src/metabase/model_persistence/api.clj b/src/metabase/model_persistence/api.cljindex 21d86d602d5..8fe6587011b 100644--- a/src/metabase/model_persistence/api.clj+++ b/src/metabase/model_persistence/api.clj@@ -61,6 +61,10 @@:next-fire-time (get-in db-id->fire-time [database_id :next-fire-time])))results))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""List the entries of [[PersistedInfo]] in order to show a status page."[]@@ -84,6 +88,10 @@:limit (request/limit):offset (request/offset)}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:persisted-info-id""Fetch a particular [[PersistedInfo]] by id."[{:keys [persisted-info-id]} :- [:map@@ -92,6 +100,10 @@(api/write-check (t2/select-one :model/Database :id (:database_id persisted-info)))persisted-info))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/card/:card-id""Fetch a particular [[PersistedInfo]] by card-id."[{:keys [card-id]} :- [:map@@ -108,6 +120,10 @@[:fn {:error/message (deferred-tru "String representing a cron schedule")} #(= 7 (count (str/split % #" ")))]](deferred-tru "Value must be a string representing a cron schedule of format <seconds> <minutes> <hours> <day of month> <month> <day of week> <year>")))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/set-refresh-schedule""Set the cron schedule to refresh persisted models.Shape should be JSON like {cron: \"0 30 1/8 * * ? *\"}."@@ -126,6 +142,10 @@(task.persist-refresh/reschedule-refresh!)api/generic-204-no-content)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/enable""Enable global setting to allow databases to persist models."[]@@ -149,6 +169,10 @@{:settings (not-empty (dissoc (:settings db) :persist-models-enabled))}))(task.persist-refresh/disable-persisting!)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/disable""Disable global setting to allow databases to persist models. This will remove all tasks to refresh tables, removethat option from databases which might have it enabled, and delete all cached tables."@@ -167,6 +191,10 @@;;; Card endpoints;;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/card/:card-id/persist""Mark the model (card) as persisted. Runs the query and saves it to the database backing the card and hot swaps thisquery in place of the model's query."@@ -190,6 +218,10 @@(task.persist-refresh/schedule-refresh-for-individual! persisted-info))api/generic-204-no-content)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/card/:card-id/refresh""Refresh the persisted model caching `card-id`."[{:keys [card-id]} :- [:map@@ -204,6 +236,10 @@(task.persist-refresh/schedule-refresh-for-individual! persisted-info)api/generic-204-no-content))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/card/:card-id/unpersist""Unpersist this model. Deletes the persisted table backing the model and all queries after this will use the card'squery rather than the saved version of the query."@@ -220,6 +256,10 @@;;; Database endpoints;;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/database/:id/persist""Attempt to enable model persistence for a database. If already enabled returns a generic 204."[{:keys [id]} :- [:map@@ -245,6 +285,10 @@{:error error:database (:name database)})))))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/database/:id/unpersist""Attempt to disable model persistence for a database. If already not enabled, just returns a generic 204."[{:keys [id]} :- [:mapdiff --git a/src/metabase/native_query_snippets/api.clj b/src/metabase/native_query_snippets/api.cljindex aa233c5fb43..ba413da8406 100644--- a/src/metabase/native_query_snippets/api.clj+++ b/src/metabase/native_query_snippets/api.clj@@ -25,6 +25,10 @@{:order-by [[:%lower.name :asc]]})](t2/hydrate (filter mi/can-read? snippets) :creator :is_remote_synced))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Fetch all snippets"[_route-params@@ -38,6 +42,10 @@(-> (api/read-check (t2/select-one :model/NativeQuerySnippet :id id))(t2/hydrate :creator :is_remote_synced)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Fetch native query snippet with ID."[{:keys [id]} :- [:map@@ -49,6 +57,10 @@(throw (ex-info (tru "A snippet with that name already exists. Please pick a different name."){:status-code 400}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new `NativeQuerySnippet`."[_route-params@@ -85,6 +97,10 @@(collections/check-for-remote-sync-update snippet)))(get-native-query-snippet id)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update an existing `NativeQuerySnippet`."[{:keys [id]} :- [:mapdiff --git a/src/metabase/notification/api/notification.clj b/src/metabase/notification/api/notification.cljindex 86cb32d3a16..506031cb011 100644--- a/src/metabase/notification/api/notification.clj+++ b/src/metabase/notification/api/notification.clj@@ -87,7 +87,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""List notifications.- `creator_id`: if provided returns only notifications created by this user@@ -110,6 +115,10 @@:include_inactive include_inactive:payload_type payload_type}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Get a notification by id."[{:keys [id]} :- [:map [:id ms/PositiveInt]]]@@ -137,6 +146,10 @@(messages/send-you-were-added-card-notification-email!(update notification :payload t2/hydrate :card) recipients-except-creator @api/*current-user*)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new notification, return the created notification."[_route _query body :- ::models.notification/FullyHydratedNotification]@@ -180,6 +193,10 @@(when (seq added-recipients)(messages/send-you-were-added-card-notification-email! notification added-recipients @api/*current-user*)))))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update a notification, can also update its subscriptions, handlers.Return the updated notification."@@ -196,6 +213,10 @@:previous-object existing-notification:user-id api/*current-user-id*}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/send""Send a notification by id."[{:keys [id]} :- [:map [:id ms/PositiveInt]]@@ -221,6 +242,10 @@%))(m/update-existing :subscriptions #(map (fn [x] (t2/instance :model/NotificationSubscription x)) %))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/send""Send an unsaved notification."[_route _query body :- ::models.notification/FullyHydratedNotification]@@ -246,6 +271,10 @@(events/publish-event! :event/notification-unsubscribe {:object {:id notification-id}:user-id api/*current-user-id*}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/unsubscribe""Unsubscribe current user from a notification."[{:keys [id]} :- [:map [:id ms/PositiveInt]]]diff --git a/src/metabase/notification/api/unsubscribe.clj b/src/metabase/notification/api/unsubscribe.cljindex 8571f8b0473..6d650410d4e 100644--- a/src/metabase/notification/api/unsubscribe.clj+++ b/src/metabase/notification/api/unsubscribe.clj@@ -38,6 +38,10 @@:notification/dashboard (->> notification :payload :dashboard_id (t2/select-one-fn :name :model/Dashboard))(name (:payload_type notification)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Allow non-users to unsubscribe from notifications, with the hash given through email."[_route-params@@ -60,6 +64,10 @@:object {:id notification-handler-id}}){:status :success :title (notification-name-by-handler-id notification-handler-id)})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/undo""Allow non-users to undo an unsubscribe from notifications, with the hash given through email."[_route-paramsdiff --git a/src/metabase/permissions_rest/api.clj b/src/metabase/permissions_rest/api.cljindex ab6c90f3c74..de1112866ae 100644--- a/src/metabase/permissions_rest/api.clj+++ b/src/metabase/permissions_rest/api.clj@@ -20,12 +20,20 @@[metabase.util.malli.schema :as ms][toucan2.core :as t2]))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/graph""Fetch a graph of all Permissions."[](api/check-superuser)(data-perms.graph/api-graph))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/graph/db/:db-id""Fetch a graph of all Permissions for db-id `db-id`."[{:keys [db-id]} :- [:map@@ -33,6 +41,10 @@(api/check-superuser)(data-perms.graph/api-graph {:db-id db-id}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/graph/group/:group-id""Fetch a graph of all Permissions for group-id `group-id`."[{:keys [group-id]} :- [:map@@ -52,6 +64,10 @@[_impersonations](throw (premium-features/ee-feature-error (tru "Connection impersonation"))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/graph""Do a batch update of Permissions by passing in a modified graph. This should return the same graph, in the sameformat, that you got from `GET /api/permissions/graph`, with any changes made in the wherever necessary. This@@ -119,6 +135,10 @@(some? offset) (sql.helpers/offset offset)(some? query) (sql.helpers/where query))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/group""Fetch all `PermissionsGroups`, including a count of the number of `:members` in that group.This API requires superuser or group manager of more than one group.@@ -140,6 +160,10 @@(-> (ordered-groups (request/limit) (request/offset) query)(t2/hydrate :member_count))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/group/:id""Fetch the details for a certain permissions group."[{:keys [id]} :- [:map@@ -149,6 +173,10 @@(-> (t2/select-one :model/PermissionsGroup :id id)(t2/hydrate :members))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/group""Create a new `PermissionsGroup`."[_route-params@@ -161,6 +189,10 @@(events/publish-event! :event/group-create {:object <>:user-id api/*current-user-id*})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/group/:group-id""Update the name of a `PermissionsGroup`."[{:keys [group-id]} :- [:map@@ -180,6 +212,10 @@:object <>:previous-object group}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/group/:group-id""Delete a specific `PermissionsGroup`."[{:keys [group-id]} :- [:map@@ -193,6 +229,10 @@;;; ------------------------------------------- Group Membership Endpoints -------------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/membership""Fetch a map describing the group memberships of various users.This map's format is:@@ -213,6 +253,10 @@[:= :user_id api/*current-user-id*][:= :is_group_manager true]]}])))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/membership""Add a `User` to a `PermissionsGroup`. Returns updated list of members belonging to the group."[_route-params@@ -235,6 +279,10 @@(:members (t2/hydrate (t2/instance :model/PermissionsGroup {:id group_id}):members))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/membership/:id""Update a Permission Group membership. Returns the updated record."[{:keys [id]} :- [:map@@ -256,6 +304,10 @@{:is_group_manager is_group_manager})(t2/select-one :model/PermissionsGroupMembership :id (:id old))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/membership/:group-id/clear""Remove all members from a `PermissionsGroup`. Returns a 400 (Bad Request) if the group ID is for the admin group."[{:keys [group-id]} :- [:map@@ -266,6 +318,10 @@(t2/delete! :model/PermissionsGroupMembership :group_id group-id)api/generic-204-no-content)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/membership/:id""Remove a User from a PermissionsGroup (delete their membership)."[{:keys [id]} :- [:mapdiff --git a/src/metabase/premium_features/api.clj b/src/metabase/premium_features/api.cljindex 885002f2137..7c71faeb34c 100644--- a/src/metabase/premium_features/api.clj+++ b/src/metabase/premium_features/api.clj@@ -4,6 +4,10 @@[metabase.api.macros :as api.macros][metabase.premium-features.core :as premium-features]))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/token/status""Fetch info about the current Premium-Features premium features token including whether it is `valid`, a `trial` token, its`features`, when it is `valid-thru`, and the `status` of the account."diff --git a/src/metabase/product_feedback/api.clj b/src/metabase/product_feedback/api.cljindex 3388e394215..56dbd0146b4 100644--- a/src/metabase/product_feedback/api.clj+++ b/src/metabase/product_feedback/api.clj@@ -27,6 +27,10 @@(log/warn e)(throw e))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Endpoint to provide feedback from the product"[_route-paramsdiff --git a/src/metabase/public_sharing_rest/api.clj b/src/metabase/public_sharing_rest/api.cljindex 5437a812a86..7d7512d8d15 100644--- a/src/metabase/public_sharing_rest/api.clj+++ b/src/metabase/public_sharing_rest/api.clj@@ -89,6 +89,10 @@(defn- card-with-uuid [uuid] (public-card :public_uuid uuid))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/card/:uuid""Fetch a publicly-accessible Card an return query results as well as `:card` information. Does not require authcredentials. Public sharing must be enabled."@@ -170,6 +174,10 @@(let [card-id (api/check-404 (t2/select-one-pk :model/Card :public_uuid uuid, :archived false))](apply process-query-for-card-with-id card-id export-format parameters options)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/card/:uuid/query""Fetch a publicly-accessible Card an return query results as well as `:card` information. Does not require authcredentials. Public sharing must be enabled."@@ -181,7 +189,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/card/:uuid/query/:export-format""Fetch a publicly-accessible Card and return query results in the specified format. Does not require authcredentials. Public sharing must be enabled."@@ -250,6 +263,10 @@(defn- dashboard-with-uuid [uuid] (public-dashboard :public_uuid uuid))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/dashboard/:uuid""Fetch a publicly-accessible Dashboard. Does not require auth credentials. Public sharing must be enabled."[{:keys [uuid]} :- [:map@@ -292,6 +309,10 @@(binding [api/*current-user-id* nil](m/mapply qp.dashboard/process-query-for-dashcard options)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/dashboard/:uuid/dashcard/:dashcard-id/card/:card-id""Fetch the results for a Card in a publicly-accessible Dashboard. Does not require auth credentials. Publicsharing must be enabled."@@ -311,6 +332,10 @@:export-format :api:parameters parameters)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post ["/dashboard/:uuid/dashcard/:dashcard-id/card/:card-id/:export-format":export-format qp.schema/export-formats-regex]"Fetch the results of running a publicly-accessible Card belonging to a Dashboard and return the data in one of the@@ -344,6 +369,10 @@:format-rows? format_rows:pivot? pivot_results}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/dashboard/:uuid/dashcard/:dashcard-id/execute""Fetches the values for filling in execution parameters. Pass PK parameters and values to select."[{:keys [uuid dashcard-id]} :- [:map@@ -359,6 +388,10 @@(def ^:private dashcard-execution-throttle (throttle/make-throttler :dashcard-id :attempts-threshold 5000))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/dashboard/:uuid/dashcard/:dashcard-id/execute""Execute the associated Action in the context of a `Dashboard` and `DashboardCard` that includes it.@@ -398,6 +431,10 @@:height height:frameborder 0}]))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/oembed""oEmbed endpoint used to retrieve embed code and metadata for a (public) Metabase URL."[_route-params@@ -420,6 +457,10 @@;;; ----------------------------------------------- Public Action ------------------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/action/:uuid""Fetch a publicly-accessible Action. Does not require auth credentials. Public sharing must be enabled."[{:keys [uuid]} :- [:map@@ -435,6 +476,10 @@;;; ------------------------------------------------ Param Values -------------------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/card/:uuid/params/:param-key/values""Fetch values for a parameter on a public card."[{:keys [uuid param-key]} :- [:map@@ -445,6 +490,10 @@(request/as-admin(queries/card-param-values card param-key))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/card/:uuid/params/:param-key/search/:query""Fetch values for a parameter on a public card containing `query`."[{:keys [uuid param-key query]} :- [:map@@ -456,6 +505,10 @@(request/as-admin(queries/card-param-values card param-key query))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/card/:uuid/params/:param-key/remapping""Fetch the remapped value for the given `value` of parameter with ID `:param-key` of card with UUID `uuid`."[{:keys [uuid param-key]} :- [:map@@ -466,6 +519,10 @@(request/as-admin(queries/card-param-remapped-value card param-key (codec/url-decode value)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/dashboard/:uuid/params/:param-key/values""Fetch filter values for dashboard parameter `param-key`."[{:keys [uuid param-key]} :- [:map@@ -477,6 +534,10 @@(binding [qp.perms/*param-values-query* true](parameters.dashboard/param-values dashboard param-key constraint-param-key->value)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/dashboard/:uuid/params/:param-key/search/:query""Fetch filter values for dashboard parameter `param-key`, containing specified `query`."[{:keys [uuid param-key query]} :- [:map@@ -489,6 +550,10 @@(binding [qp.perms/*param-values-query* true](parameters.dashboard/param-values dashboard param-key constraint-param-key->value query)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/dashboard/:uuid/params/:param-key/remapping""Fetch the remapped value for the given `value` of parameter with ID `:param-key` of dashboard with UUID `uuid`."[{:keys [uuid param-key]} :- [:map@@ -503,6 +568,11 @@;;; ----------------------------------------------------- Pivot Tables -----------------------------------------------;; TODO -- why do these endpoints START with `/pivot/` whereas the version in Dash+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/pivot/card/:uuid/query""Fetch a publicly-accessible Card an return query results as well as `:card` information. Does not require authcredentials. Public sharing must be enabled."@@ -513,6 +583,10 @@(process-query-for-card-with-public-uuid uuid :api (json/decode+kw parameters):qp qp.pivot/run-pivot-query))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/pivot/dashboard/:uuid/dashcard/:dashcard-id/card/:card-id""Fetch the results for a Card in a publicly-accessible Dashboard. Does not require auth credentials. Publicsharing must be enabled."@@ -543,6 +617,10 @@:attempt-ttl-ms 1000:delay-exponent 1))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/action/:uuid/execute""Execute the Action.@@ -580,6 +658,10 @@;;; ----------------------------------------------------- Map Tiles --------------------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/tiles/card/:uuid/:zoom/:x/:y""Generates a single tile image for a publicly-accessible Card using the map visualization. Does not require authcredentials. Public sharing must be enabled."@@ -602,6 +684,10 @@(request/as-admin(api.tiles/process-tiles-query-for-card card-id parameters zoom x y lat-field lon-field))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/tiles/dashboard/:uuid/dashcard/:dashcard-id/card/:card-id/:zoom/:x/:y""Generates a single tile image for a Card using the map visualization in a publicly-accessible Dashboard. Does notrequire auth credentials. Public sharing must be enabled."diff --git a/src/metabase/pulse/api/alert.clj b/src/metabase/pulse/api/alert.cljindex efd83c7b539..d632d6f5e77 100644--- a/src/metabase/pulse/api/alert.clj+++ b/src/metabase/pulse/api/alert.clj@@ -77,7 +77,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Fetch alerts which the current user has created or will receive, or all alerts if the user is an admin.The optional `user_id` will return alerts created by the corresponding user, but is ignored for non-admin users."@@ -95,6 +100,10 @@(map notification->pulse)(remove nil?))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Fetch an alert by ID"[{:keys [id]} :- [:map@@ -103,6 +112,10 @@api/read-checknotification->pulse))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id/subscription""For users to unsubscribe themselves from the given alert."[{:keys [id]} :- [:mapdiff --git a/src/metabase/pulse/api/pulse.clj b/src/metabase/pulse/api/pulse.cljindex 5e530313047..8eb16925016 100644--- a/src/metabase/pulse/api/pulse.clj+++ b/src/metabase/pulse/api/pulse.clj@@ -77,7 +77,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Fetch all dashboard subscriptions. By default, returns only subscriptions for which the current user has writepermissions. For admins, this is all subscriptions; for non-admins, it is only subscriptions that they created.@@ -109,6 +114,10 @@pulses)](t2/hydrate pulses :can_write)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new `Pulse`."[_route-params@@ -146,6 +155,10 @@(events/publish-event! :event/pulse-create {:object pulse :user-id api/*current-user-id*})pulse))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Fetch `Pulse` with ID. If the user is a recipient of the Pulse but does not have read permissions for its collection,we still return it but with some sensitive metadata removed."@@ -183,6 +196,10 @@(assert (integer? card-id))(api/read-check :model/Card card-id)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update a Pulse with `id`."[{:keys [id]} :- [:map@@ -236,7 +253,12 @@(models.pulse/retrieve-pulse id));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/form_input""Provides relevant configuration information and user choices for creating/updating Pulses."[]@@ -279,7 +301,12 @@:card-id card-id}))));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/preview_card/:id""Get HTML rendering of a Card with `id`."[{:keys [id]} :- [:map@@ -296,7 +323,12 @@{:channel.render/include-title? true, :channel.render/include-buttons? true})]])}));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/preview_dashboard/:id""Get HTML rendering of a Dashboard with `id`.@@ -319,7 +351,12 @@(channel.render/render-dashboard-to-html id)]))});; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/preview_card_info/:id""Get JSON object containing HTML rendering of a Card with `id` and other information."[{:keys [id]} :- [:map@@ -343,7 +380,12 @@(def ^:private preview-card-width 400);; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/preview_card_png/:id""Get PNG rendering of a Card with `id`. Optionally specify `width` as a query parameter."[{:keys [id]} :- [:map@@ -360,6 +402,10 @@{:channel.render/include-title? true})]{:status 200, :headers {"Content-Type" "image/png"}, :body (ByteArrayInputStream. ba)}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/test""Test send an unsaved pulse."[_route-params@@ -385,6 +431,10 @@(pulse.send/send-pulse! (assoc body :creator_id api/*current-user-id*))){:ok true})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id/subscription""For users to unsubscribe themselves from a pulse subscription."[{:keys [id]} :- [:mapdiff --git a/src/metabase/pulse/api/unsubscribe.clj b/src/metabase/pulse/api/unsubscribe.cljindex aa6c78f0d51..5000de276ce 100644--- a/src/metabase/pulse/api/unsubscribe.clj+++ b/src/metabase/pulse/api/unsubscribe.clj@@ -26,6 +26,10 @@{:type type:status-code 400}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Allow non-users to unsubscribe from pulses/subscriptions, with the hash given through email."[_route-params@@ -47,6 +51,10 @@(events/publish-event! :event/subscription-unsubscribe {:object {:email email}}){:status :success :title (:name (models.pulse/retrieve-notification pulse-id :archived false))})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/undo""Allow non-users to undo an unsubscribe from pulses/subscriptions, with the hash given through email."[_route-paramsdiff --git a/src/metabase/queries/api/card.clj b/src/metabase/queries/api/card.cljindex 9e7f0067dca..38c6f99fa1f 100644--- a/src/metabase/queries/api/card.clj+++ b/src/metabase/queries/api/card.clj@@ -125,6 +125,10 @@;;; -------------------------------------------- List of public or embeddable cards -----------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/public""Fetch a list of Cards with public UUIDs. These cards are publicly-accessible *if* public sharing is enabled."[]@@ -132,6 +136,10 @@(public-sharing.validation/check-public-sharing-enabled)(t2/select [:model/Card :name :id :public_uuid :card_schema], :public_uuid [:not= nil], :archived false))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/embeddable""Fetch a list of Cards where `enable_embedding` is `true`. The cards can be embedded using the embedding endpointsand a signed JWT."@@ -154,7 +162,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Get all the Cards. Option filter param `f` can be used to change the set of Cards that are returned; default is`all`, but other options include `mine`, `bookmarked`, `database`, `table`, `using_model`, `using_segment`, and@@ -224,6 +237,10 @@collection.root/hydrate-root-collection(api/present-in-trash-if-archived-directly (collection/trash-collection-id)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Get `Card` with ID.@@ -248,6 +265,10 @@(doseq [dashboard dashboards](api/write-check dashboard))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/dashboards""Get a list of `{:name ... :id ...}` pairs for all the dashboards this card appears in."[{:keys [id]} :- [:map@@ -420,7 +441,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/series""Fetches a list of compatible series with the card with id `card_id`.@@ -510,6 +536,10 @@[:dashboard_id {:optional true} [:maybe ms/PositiveInt]][:dashboard_tab_id {:optional true} [:maybe ms/PositiveInt]]])+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new `Card`. Card `type` can be `question`, `metric`, or `model`."[_route-params@@ -534,6 +564,10 @@hydrate-card-details(assoc :last-edit-info (revisions/edit-information-for-user @api/*current-user*)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/copy""Copy a `Card`, with the new name 'Copy of _name_'"[{:keys [id]} :- [:map@@ -692,7 +726,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update a `Card`."[{:keys [id]} :- [:map@@ -703,7 +742,12 @@(update-card! id body (boolean delete-old-dashcards?)));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/query_metadata""Get all of the required query metadata for a card."[{:keys [id]} :- [:map@@ -714,6 +758,10 @@;;; ------------------------------------------------- Deleting Cards -------------------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id""Hard delete a Card. To soft delete, use `PUT /api/card/:id`"[{:keys [id]} :- [:map@@ -798,6 +846,10 @@(when new-collection-id-or-nil(events/publish-event! :event/collection-touch {:collection-id new-collection-id-or-nil :user-id api/*current-user-id*})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/collections""Bulk update endpoint for Card Collections. Move a set of `Cards` with `card_ids` into a `Collection` with`collection_id`, or remove them from any Collections by passing a `null` `collection_id`."@@ -811,6 +863,10 @@;;; ------------------------------------------------ Running a Query -------------------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:card-id/query""Run the query associated with a Card."[{:keys [card-id]} :- [:map@@ -835,6 +891,10 @@:context (if collection_preview :collection :question):middleware {:process-viz-settings? false})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:card-id/query/:export-format""Run the query associated with a Card, and return its results as a file in the specified format.@@ -878,7 +938,12 @@;;; ----------------------------------------------- Sharing is Caring ------------------------------------------------;; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:card-id/public_link""Generate publicly-accessible links for this Card. Returns UUID to be used in public links. (If this Card hasalready been shared, it will return the existing public link rather than creating a new one.) Public sharing must@@ -896,7 +961,12 @@:made_public_by_id api/*current-user-id*})))}));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:card-id/public_link""Delete the publicly-accessible link to this Card."[{:keys [card-id]} :- [:map@@ -909,6 +979,10 @@:made_public_by_id nil}){:status 204, :body nil})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/pivot/:card-id/query""Run the query associated with a Card."[{:keys [card-id]} :- [:map@@ -922,6 +996,10 @@:qp qp.pivot/run-pivot-query:ignore-cache ignore_cache))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:card-id/params/:param-key/values""Fetch possible values of the parameter whose ID is `:param-key`.@@ -932,6 +1010,10 @@[:param-key ::lib.schema.parameter/id]]](queries.card/card-param-values (api/read-check :model/Card card-id) param-key))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:card-id/params/:param-key/search/:query""Fetch possible values of the parameter whose ID is `:param-key` that contain `:query`.@@ -945,6 +1027,10 @@[:query ms/NonBlankString]]](queries.card/card-param-values (api/read-check :model/Card card-id) param-key query))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/params/:param-key/remapping""Fetch the remapped value for a given value of the parameter with ID `:param-key`.diff --git a/src/metabase/queries/api/cards.clj b/src/metabase/queries/api/cards.cljindex 914bcb9efca..0c00168548a 100644--- a/src/metabase/queries/api/cards.clj+++ b/src/metabase/queries/api/cards.clj@@ -14,6 +14,10 @@:else dashboard)(select-keys [:id :name :error])))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/dashboards""Get the dashboards that multiple cards appear in. The response is a sequence of maps, each of which has a `card_id`and `dashboards`. `dashboard` may include an `:error` key, either `:unreadable-dashboard` or@@ -31,6 +35,10 @@{:card_id id :dashboards (map present-dashboard in_dashboards)})$))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/move""Moves a number of Cards to a single collection or dashboard.diff --git a/src/metabase/query_processor/api.clj b/src/metabase/query_processor/api.cljindex 96712264111..706c133c7e5 100644--- a/src/metabase/query_processor/api.clj+++ b/src/metabase/query_processor/api.clj@@ -88,6 +88,10 @@rff))(qp/process-query (update query :info merge info) rff))))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Execute a query and retrieve the results in the usual format. The query will not use the cache."[_route-params@@ -119,6 +123,10 @@json-key(keyword json-key)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post ["/:export-format", :export-format qp.schema/export-formats-regex]"Execute a query and download the result data as a file in the specified format."[{:keys [export-format]} :- [:map@@ -162,7 +170,12 @@;;; ------------------------------------------------ Other Endpoints -------------------------------------------------;; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/query_metadata""Get all of the required query metadata for an ad-hoc query."[_route-params@@ -172,6 +185,10 @@(lib-be/with-metadata-provider-cache(queries/batch-fetch-query-metadata [query])))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/native""Fetch a native version of an MBQL query."[_route-params@@ -187,6 +204,10 @@(cond-> compiledpretty (update :query prettify)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/pivot""Generate a pivoted dataset for an ad-hoc query"[_route-params@@ -227,6 +248,10 @@parameter query(fn [] (parameter-field-values field-ids query))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/parameter/values""Return parameter values for cards or dashboards that are being edited."[_route-params@@ -237,6 +262,10 @@[:field_ids {:optional true} [:maybe [:sequential ::lib.schema.id/field]]]]](parameter-values parameter field-ids nil))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/parameter/search/:query""Return parameter values for cards or dashboards that are being edited. Expects a query string at `?query=foo`."[{:keys [query]} :- [:map@@ -262,6 +291,10 @@first))[value]))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/parameter/remapping""Return the remapped parameter values for cards or dashboards that are being edited."[_route-paramsdiff --git a/src/metabase/revisions/api.clj b/src/metabase/revisions/api.cljindex 847d9e70e12..f31c356230a 100644--- a/src/metabase/revisions/api.clj+++ b/src/metabase/revisions/api.clj@@ -25,6 +25,10 @@(assert (keyword? model))[model (t2/select-one model :id id)]))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Get revisions of an object."[_route-params@@ -35,6 +39,10 @@(when (api/read-check instance)(revision/revisions+details model id))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/revert""Revert an object to a prior revision."[_route-params@@ -58,6 +66,10 @@:user-id api/*current-user-id*:revision-id revision-id})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:entity/:id""Fetch `Revisions` for an object with ID."[{:keys [id entity]} :- [:mapdiff --git a/src/metabase/search/api.clj b/src/metabase/search/api.cljindex 016179120e9..7b5064b7450 100644--- a/src/metabase/search/api.clj+++ b/src/metabase/search/api.clj@@ -67,6 +67,10 @@(fn [prefix](open-api/open-api-spec handler prefix))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/re-init""This will blow away any search indexes, re-create, and re-populate them."[]@@ -75,6 +79,10 @@{:message (search/init-index! {:force-reset? true})}(throw (ex-info "Search index is not supported for this installation." {:status-code 501}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/force-reindex""This will trigger an immediate reindexing, if we are using search index."[]@@ -110,7 +118,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/weights""Return the current weights being used to rank the search results"[_route-params@@ -119,7 +132,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/weights""Update the current weights being used to rank the search results"[_route-params@@ -134,7 +152,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Search for items in Metabase.For the list of supported models, check [[metabase.search.config/all-models]].diff --git a/src/metabase/segments/api.clj b/src/metabase/segments/api.cljindex 264221d8986..87d1ace699d 100644--- a/src/metabase/segments/api.clj+++ b/src/metabase/segments/api.clj@@ -15,6 +15,10 @@[metabase.xrays.core :as xrays][toucan2.core :as t2]))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new `Segment`."[_route-params@@ -40,12 +44,20 @@(-> (api/read-check (t2/select-one :model/Segment :id id))(t2/hydrate :creator)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Fetch `Segment` with ID."[{:keys [id]} :- [:map[:id ms/PositiveInt]]](hydrated-segment id))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Fetch *all* `Segments`."[]@@ -77,6 +89,10 @@(events/publish-event! (if archive? :event/segment-delete :event/segment-update){:object <> :user-id api/*current-user-id* :revision-message revision_message}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update a `Segment` with ID."[{:keys [id]} :- [:map@@ -95,7 +111,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id""Archive a Segment. (DEPRECATED -- Just pass updated value of `:archived` to the `PUT` endpoint instead.)"[{:keys [id]} :- [:map@@ -106,6 +127,10 @@(write-check-and-update-segment! id {:archived true, :revision_message revision_message})api/generic-204-no-content)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/related""Return related entities."[{:keys [id]} :- [:mapdiff --git a/src/metabase/session/api.clj b/src/metabase/session/api.cljindex edf00ae576e..480e442e06e 100644--- a/src/metabase/session/api.clj+++ b/src/metabase/session/api.clj@@ -114,6 +114,10 @@[& body]`(do-http-401-on-error (fn [] ~@body)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Login."[_route-params@@ -135,6 +139,10 @@(login-throttlers :username) username](do-login))))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/""Logout.";; `metabase-session-key` gets added automatically by the [[metabase.server.middleware.session]] middleware@@ -188,7 +196,12 @@{:object (assoc user :token (t2/select-one-fn :reset_token :model/User :id user-id))}))));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/forgot_password""Send a reset email when user has forgotten their password."[_route-params@@ -208,7 +221,12 @@(throttle/make-throttler :password :attempts-threshold 10));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/reset_password""Reset password with a reset token."[_route-params@@ -231,7 +249,12 @@(api/throw-invalid-param-exception :password (tru "Invalid reset token")))));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/password_reset_token_valid""Check if a password reset token is valid and isn't expired."[_route-params@@ -243,6 +266,10 @@{:token token})]{:valid (:success? auth-result)}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/properties""Get all properties and their values. These are the specific `Settings` that are readable by the current user, or arepublic if no user is logged in."@@ -250,7 +277,12 @@(setting/user-readable-values-map (setting/current-user-readable-visibilities)));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/google_auth""Login with Google Auth."[_route-params@@ -285,6 +317,10 @@(throttle/with-throttling [(login-throttlers :ip-address) (request/ip-address request)](do-login))))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/password-check""Endpoint that checks if the supplied password meets the currently configured password complexity rules."[_route-paramsdiff --git a/src/metabase/settings_rest/api.clj b/src/metabase/settings_rest/api.cljindex 977bfbabc49..17726b03c03 100644--- a/src/metabase/settings_rest/api.clj+++ b/src/metabase/settings_rest/api.clj@@ -29,6 +29,11 @@(assoc-in response [:mb/cookies :cookie/settings-cache-timestamp] true));; TODO: deprecate /api/session/properties and have a single endpoint for listing settings+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Get all `Settings` and their values. You must be a superuser or have `setting` permission to do this.For non-superusers, a list of visible settings and values can be retrieved using the /api/session/properties endpoint."@@ -40,6 +45,10 @@"Keyword that can be transformed from \"a_b\" -> :a-b"[:keyword {:decode/json #(keyword (u/->kebab-case-en %))}])+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/""Update multiple `Settings` values. If called by a non-superuser, only user-local settings can be updated."[_route-params@@ -49,6 +58,10 @@(setting/set-many! settings))(add-settings-last-updated-cookie api/generic-204-no-content))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:key""Fetch a single `Setting`."[{:keys [key]} :- [:map@@ -56,6 +69,10 @@(with-setting-access-control(setting/user-facing-value key)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:key""Create/update a `Setting`. If called by a non-admin, only user-local settings can be updated.This endpoint can also be used to delete Settings by passing `nil` for `:value`."diff --git a/src/metabase/setup_rest/api.clj b/src/metabase/setup_rest/api.cljindex 7ac7e4020fd..87fd607af4d 100644--- a/src/metabase/setup_rest/api.clj+++ b/src/metabase/setup_rest/api.clj@@ -62,6 +62,10 @@;; default to `true` the setting will set itself correctly whether a boolean or boolean string is specified(analytics/anon-tracking-enabled! true))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Special endpoint for creating the first user during setup. This endpoint both creates the user AND logs them in andreturns a session ID. This endpoint can also be used to set specific settings from the setup flow."diff --git a/src/metabase/sso/api/google.clj b/src/metabase/sso/api/google.cljindex 33e483b35bd..42e186ce7db 100644--- a/src/metabase/sso/api/google.clj+++ b/src/metabase/sso/api/google.clj@@ -7,6 +7,10 @@[metabase.sso.settings :as sso.settings][toucan2.core :as t2]))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/settings""Update Google Sign-In related settings. You must be a superuser to do this."[_route-paramsdiff --git a/src/metabase/sso/api/ldap.clj b/src/metabase/sso/api/ldap.cljindex 2f96b0d9ab3..00b383d7661 100644--- a/src/metabase/sso/api/ldap.clj+++ b/src/metabase/sso/api/ldap.clj@@ -19,6 +19,10 @@current-passwordnew-password)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/settings""Update LDAP related settings. You must be a superuser to do this."[_route-paramsdiff --git a/src/metabase/sync/api/notify.clj b/src/metabase/sync/api/notify.cljindex 32d370d6a75..65f8c773db2 100644--- a/src/metabase/sync/api/notify.clj+++ b/src/metabase/sync/api/notify.clj@@ -16,6 +16,10 @@(set! *warn-on-reflection* true)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/db/:id""Notification about a potential schema change to one of our `Databases`.Caller can optionally specify a `:table_id` or `:table_name` in the body to limit updates to a single@@ -65,7 +69,12 @@:table_name table-name}))))));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/db/attached_datawarehouse""Sync the attached datawarehouse. Can provide in the body:- table_name and schema_name: both strings. Will look for an existing table and sync it, otherwise will try to find a@@ -90,6 +99,10 @@(find-and-sync-new-table database table_name schema_name)))){:success true})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/db/:id/new-table""Sync a new table without running a full database sync. Requires `schema_name` and `table_name`. Will throw an errorif the table already exists in Metabase or cannot be found."diff --git a/src/metabase/task_history/api.clj b/src/metabase/task_history/api.cljindex 9526774c896..955338302c3 100644--- a/src/metabase/task_history/api.clj+++ b/src/metabase/task_history/api.clj@@ -9,6 +9,10 @@[metabase.task.core :as task][metabase.util.malli.schema :as ms]))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Fetch a list of recent tasks stored as Task History"[_@@ -19,12 +23,20 @@:offset (request/offset):data (task-history/all (request/limit) (request/offset) params)})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Get `TaskHistory` entry with ID."[{:keys [id]} :- [:map[:id ms/PositiveInt]]](api/check-404 (api/read-check :model/TaskHistory id)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/info""Return raw data about all scheduled tasks (i.e., Quartz Jobs and Triggers)."[]@@ -33,6 +45,11 @@;;; TODO -- this is not necessarily a 'task history' thing and maybe belongs in the `task` module's API rather than;;; here... maybe a problem for another day.+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/unique-tasks""Returns possibly empty vector of unique task names in alphabetical order. It is expected that number of uniquetasks is small, hence no need for pagination. If that changes this endpoint and function that powers it shoulddiff --git a/src/metabase/testing_api/api.clj b/src/metabase/testing_api/api.cljindex 142c8097c33..6c2e9355f4f 100644--- a/src/metabase/testing_api/api.clj+++ b/src/metabase/testing_api/api.clj@@ -47,6 +47,10 @@(jdbc/query {:datasource (mdb/app-db)} ["SCRIPT TO ?" path])):ok)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/snapshot/:name""Snapshot the database for testing purposes."[{snapshot-name :name} :- [:map@@ -118,6 +122,10 @@(mdb/migrate! (mdb/app-db) :up))))):ok)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/restore/:name""Restore a database snapshot for testing purposes."[{snapshot-name :name} :- [:map@@ -127,6 +135,10 @@(search/reindex! {:async? false})nil)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/echo""Simple echo hander. Fails when you POST with `?fail=true`."[_route-params@@ -139,6 +151,10 @@{:status 200:body body}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/set-time""Make java-time see world at exact time."[_route-params@@ -156,6 +172,10 @@{:result (if clock :set :reset):time (t/instant)}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/echo""Simple echo hander. Fails when you GET with `?fail=true`."[_route-params@@ -168,6 +188,10 @@{:status 200:body (json/decode+kw body)}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/mark-stale""Mark the card or dashboard as stale"[_route-params@@ -188,6 +212,10 @@"card" (t2/update! :model/Card :id id {:last_used_at date})"dashboard" (t2/update! :model/Dashboard :id id {:last_viewed_at date}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/stats""Triggers a send of instance usage stats"[]@@ -199,6 +227,10 @@metabase-enterprise.cache.task.refresh-cache-configs[])+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/refresh-caches""Manually triggers the cache refresh task, if Enterprise code is available."[]diff --git a/src/metabase/tiles/api.clj b/src/metabase/tiles/api.cljindex ded10c72ad9..19589f87ba1 100644--- a/src/metabase/tiles/api.clj+++ b/src/metabase/tiles/api.clj@@ -225,6 +225,11 @@;; string param). We evaluate the query and find the set of lat/lon pairs which are relevant and then render the;; appropriate ones. It's expected that to render a full map view several calls will be made to this endpoint in;; parallel.+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:zoom/:x/:y""Generates a single tile image for an ad-hoc query."[{:keys [zoom x y]} :- [:map@@ -296,6 +301,10 @@(json/decode+kw s)))}::parameters.schema/parameters])+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:card-id/:zoom/:x/:y""Generates a single tile image for a saved Card."[{:keys [card-id zoom x y]}@@ -311,6 +320,10 @@[:lonField ::legacy-ref]]](process-tiles-query-for-card card-id parameters zoom x y lat-field lon-field))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:dashboard-id/dashcard/:dashcard-id/card/:card-id/:zoom/:x/:y""Generates a single tile image for a dashcard."[{:keys [dashboard-id dashcard-id card-id zoom x y], :as _route-params}diff --git a/src/metabase/timeline/api/timeline.clj b/src/metabase/timeline/api/timeline.cljindex 96dc77ee05b..361e44ffbb7 100644--- a/src/metabase/timeline/api/timeline.clj+++ b/src/metabase/timeline/api/timeline.clj@@ -24,6 +24,10 @@[:map[:id pos-int?]])+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/" :- ::Timeline"Create a new [[Timeline]]."[_route-params@@ -45,6 +49,10 @@(when config/ee-available?(events/publish-event! :event/timeline-create {:object <> :user-id api/*current-user-id*})))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/" :- [:sequential ::Timeline]"Fetch a list of `Timeline`s. Can include `archived=true` to return archived timelines."[_route-params@@ -61,6 +69,10 @@(= include :events)(map #(timeline-event/include-events-singular % {:events/all? archived?})))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id" :- ::Timeline"Fetch the `Timeline` with `id`. Include `include=events` to unarchived events included on the timeline. Add`archived=true` to return all events on the timeline, both archived and unarchived."@@ -84,6 +96,10 @@:events/start (when start (u.date/parse start)):events/end (when end (u.date/parse end))}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update the [[Timeline]] with `id`. Returns the timeline without events. Archiving a timeline will archive all of theevents in that timeline."@@ -110,6 +126,10 @@(when config/ee-available?(events/publish-event! :event/timeline-update {:object <> :user-id api/*current-user-id*})))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id""Delete a [[Timeline]]. Will cascade delete its events as well."[{:keys [id]} :- [:map@@ -120,6 +140,10 @@(events/publish-event! :event/timeline-delete {:object timeline :user-id api/*current-user-id*})))api/generic-204-no-content)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/collection/root""Fetch the root Collection's timelines."[_route-params@@ -130,6 +154,10 @@(timeline/timelines-for-collection nil {:timeline/events? (= include "events"):timeline/archived? archived}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/collection/:id""Fetch a specific Collection's timelines."[{:keys [id]} :- [:mapdiff --git a/src/metabase/timeline/api/timeline_event.clj b/src/metabase/timeline/api/timeline_event.cljindex 5d707762f68..0881d06e0b5 100644--- a/src/metabase/timeline/api/timeline_event.clj+++ b/src/metabase/timeline/api/timeline_event.clj@@ -14,6 +14,10 @@[metabase.util.malli.schema :as ms][toucan2.core :as t2]))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new [[TimelineEvent]]."[_route-params@@ -57,12 +61,20 @@(when config/ee-available?(events/publish-event! :event/timeline-create {:object <> :user-id api/*current-user-id*}))))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Fetch the [[TimelineEvent]] with `id`."[{:keys [id]} :- [:map[:id ms/PositiveInt]]](api/read-check :model/TimelineEvent id))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update a [[TimelineEvent]]."[{:keys [id]} :- [:map@@ -91,6 +103,10 @@(when config/ee-available?(events/publish-event! :event/timeline-update {:object (t2/select-one :model/Timeline :id (:timeline_id <>)) :user-id api/*current-user-id*})))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id""Delete a [[TimelineEvent]]."[{:keys [id]} :- [:mapdiff --git a/src/metabase/upload/api.clj b/src/metabase/upload/api.cljindex ef17a0491dc..a6fe7403e47 100644--- a/src/metabase/upload/api.clj+++ b/src/metabase/upload/api.clj@@ -30,6 +30,10 @@(tru "There was an error uploading the file"))}})(finally (io/delete-file file :silently))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/csv""Create a table and model populated with the values from the attached CSV. Returns the model ID if successful."{:multipart true}diff --git a/src/metabase/user_key_value/api.clj b/src/metabase/user_key_value/api.cljindex ace3b530760..12df8760430 100644--- a/src/metabase/user_key_value/api.clj+++ b/src/metabase/user_key_value/api.clj@@ -10,6 +10,10 @@[metabase.user-key-value.models.user-key-value.types :as types][metabase.util.malli.schema :as ms]))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/namespace/:namespace/key/:key""Upsert a KV-pair for the user"[{nmspace :namespace, k :key} :- [:map@@ -35,6 +39,10 @@(api/check-400 false))(throw e))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/namespace/:namespace/key/:key""Get a value for the user"[{nmspace :namespace, k :key} :- [:map@@ -42,12 +50,20 @@[:namespace ms/NonBlankString]]](user-key-value/retrieve api/*current-user-id* nmspace k))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/namespace/:namespace""Returns all KV pairs in a given namespace for the current user"[{nmspace :namespace} :- [:map[:namespace ms/NonBlankString]]](user-key-value/retrieve-all api/*current-user-id* nmspace))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/namespace/:namespace/key/:key""Deletes a KV-pair for the user"[{nmspace :namespace, k :key}]diff --git a/src/metabase/users_rest/api.clj b/src/metabase/users_rest/api.cljindex 4863ae448fa..df1020ed19a 100644--- a/src/metabase/users_rest/api.clj+++ b/src/metabase/users_rest/api.clj@@ -170,7 +170,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Fetch a list of `Users` for admins or group managers.By default returns only active users for admins and only active users within groups that the group manager is@@ -250,6 +255,10 @@:where [:and [:= :permissions_group_membership.user_id user-id][:not= :permissions_group_membership.group_id (:id (perms/all-users-group))]]}]})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/recipients""Fetch a list of `Users`. Returns only active users. Meant for non-admins unlike GET /api/user.@@ -345,6 +354,10 @@(assoc user:custom_homepage (when valid? {:dashboard_id id}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/current""Fetch the current `User`."[]@@ -356,6 +369,10 @@maybe-add-sso-sourceadd-custom-homepage-info))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Fetch a `User`. You must be fetching yourself *or* be a superuser *or* a Group Manager."[{:keys [id]} :- [:map@@ -394,6 +411,10 @@(-> (fetch-user :id new-user-id)(t2/hydrate :user_group_memberships)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Create a new `User`, return a 400 if the email address is already taken"[_route-params@@ -432,6 +453,10 @@(= (get user name-key) new-name)(not sso_source)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update an existing, active `User`.Self or superusers can update user info and groups.@@ -507,6 +532,10 @@;; now return the existing user whether they were originally active or not(fetch-user :id (u/the-id existing-user)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id/reactivate""Reactivate user at `:id`"[{:keys [id]} :- [:map@@ -527,6 +556,10 @@;;; | Updating a Password -- PUT /api/user/:id/password |;;; +----------------------------------------------------------------------------------------------------------------++;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id/password""Update a user's password."[{:keys [id]} :- [:map@@ -558,6 +591,10 @@;;; | Deleting (Deactivating) a User -- DELETE /api/user/:id |;;; +----------------------------------------------------------------------------------------------------------------++;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id""Disable a `User`. This does not remove the `User` from the DB, but instead disables their account."[{:keys [id]} :- [:map@@ -575,6 +612,11 @@;;; +----------------------------------------------------------------------------------------------------------------+;; TODO - This could be handled by PUT /api/user/:id, we don't need a separate endpoint+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id/modal/:modal""Indicate that a user has been informed about the vast intricacies of 'the' Query Builder."[{:keys [id modal]} :- [:mapdiff --git a/src/metabase/warehouse_schema_rest/api/field.clj b/src/metabase/warehouse_schema_rest/api/field.cljindex 1baddb25048..7cbcc5b0faa 100644--- a/src/metabase/warehouse_schema_rest/api/field.clj+++ b/src/metabase/warehouse_schema_rest/api/field.clj@@ -40,7 +40,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Get `Field` with ID."[{:keys [id]} :- [:map@@ -100,6 +105,10 @@{:active false})))nil)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update `Field` with ID."[{:keys [id]} :- [:map@@ -182,6 +191,10 @@;;; ------------------------------------------------- Field Metadata -------------------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/summary""Get the count and distinct count of `Field` with ID."[{:keys [id]} :- [:map@@ -192,6 +205,10 @@;;; --------------------------------------------------- Dimensions ---------------------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/dimension""Sets the dimension for the given field at ID"[{:keys [id]} :- [:map@@ -219,6 +236,10 @@:human_readable_field_id human-readable-field-id}))(t2/select-one :model/Dimension :field_id id))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id/dimension""Remove the dimension associated to field at ID"[{:keys [id]} :- [:map@@ -227,6 +248,10 @@(t2/delete! :model/Dimension :field_id id)api/generic-204-no-content)+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/values""If a Field's value of `has_field_values` is `:list`, return a list of all the distinct values of the Field (orremapped Field), and (if defined by a User) a map of human-readable remapped values. If `has_field_values` is not@@ -247,6 +272,10 @@[400 "If remapped values are specified, they must be specified for all field values"])has-human-readable-values?))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/values""Update the fields values and human-readable values for a `Field` whose semantic type is`category`/`city`/`state`/`country` or whose base type is `type/Boolean`. The human-readable values are optional."@@ -269,7 +298,12 @@{:status :success});; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/rescan_values""Manually trigger an update for the FieldValues for this Field. Only applies to Fields that are eligible forFieldValues."@@ -285,7 +319,12 @@{:status :success});; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/discard_values""Discard the FieldValues belonging to this Field. Only applies to fields that have FieldValues. If this Field'sDatabase is set up to automatically sync FieldValues, they will be recreated during the next cycle."@@ -302,6 +341,10 @@(defn- db-id [field](u/the-id (t2/select-one-fn :db_id :model/Table :id (table-id field))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/search/:search-id""Search for values of a Field with `search-id` that start with `value`. See docstring for[[metabase.parameters.field/search-values]] for a more detailed explanation."@@ -355,6 +398,10 @@(.parse (NumberFormat/getInstance) value)value))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/remapping/:remapped-id""Fetch remapped Field values."[{:keys [id remapped-id]} :- [:map@@ -367,6 +414,10 @@value (parse-query-param-value-for-field field value)](remapped-value field remapped-field value)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/related""Return related entities."[{:keys [id]} :- [:mapdiff --git a/src/metabase/warehouse_schema_rest/api/table.clj b/src/metabase/warehouse_schema_rest/api/table.cljindex b415be6e041..9e9b89f6d75 100644--- a/src/metabase/warehouse_schema_rest/api/table.clj+++ b/src/metabase/warehouse_schema_rest/api/table.clj@@ -61,6 +61,10 @@(mr/def ::data-sources(into [:enum {:decode/string keyword}] table/data-sources))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Get all `Tables`."[_@@ -113,7 +117,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Get `Table` with ID."[{:keys [id]} :- [:map@@ -131,6 +140,10 @@(t2/hydrate :db :pk_field)schema.table/present-table)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:table-id/data""Get the data for the given table"[{:keys [table-id]} :- [:map [:table-id ms/PositiveInt]]]@@ -212,6 +225,10 @@(sync-unhidden-tables newly-unhidden)updated-tables)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update `Table` with ID."[{:keys [id]} :- [:map@@ -233,6 +250,10 @@[:owner_user_id {:optional true} [:maybe :int]]]](first (update-tables! [id] body)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/""Update all `Table` in `ids`.@@ -257,8 +278,13 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case- :metabase/validate-defendpoint-query-params-use-kebab-case]}+ :metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/query_metadata""Get metadata about a `Table` useful for running queries.Returns DB, fields, field FKs, and field values.@@ -281,16 +307,26 @@:include-hidden-fields? include_hidden_fields:include-editable-data-model? include_editable_data_model}))-;; I think this endpoint can keep the `card__` part since it's a HACK to make IDs like `card__1` work-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/card__:id/query_metadata""Return metadata for the 'virtual' table for a Card."[{:keys [id]} :- [:map[:id ms/PositiveInt]]](first (schema.table/batch-fetch-card-query-metadatas [id] {:include-database? true})))-;; I think this endpoint can keep the `card__` part since it's a HACK to make IDs like `card__1` work-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/card__:id/fks""Return FK info for the 'virtual' table for a Card. This is always empty, so this endpointserves mainly as a placeholder to avoid having to change anything on the frontend."@@ -298,6 +334,10 @@[:id ms/PositiveInt]]][]) ; return empty array+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/fks""Get all foreign keys whose destination is a `Field` that belongs to this `Table`."[{:keys [id]} :- [:map@@ -314,7 +354,12 @@:destination (t2/hydrate (t2/select-one :model/Field :id (:fk_target_field_id origin-field)) :table)})));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/rescan_values""Manually trigger an update for the FieldValues for the Fields belonging to this Table. Only applies to Fields thatare eligible for FieldValues."@@ -333,7 +378,12 @@{:status :success}));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/discard_values""Discard the FieldValues belonging to the Fields in this Table. Only applies to fields that have FieldValues. Ifthis Table's Database is set up to automatically sync FieldValues, they will be recreated during the next cycle."@@ -344,6 +394,10 @@(t2/delete! (t2/table-name :model/FieldValues) :field_id [:in field-ids])){:status :success})+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/related""Return related entities."[{:keys [id]} :- [:map@@ -379,6 +433,10 @@(tru "There was an error uploading the file"))}})(finally (io/delete-file (:file options) :silently))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/append-csv""Inserts the rows of an uploaded CSV file into the table identified by `:id`. The table must have been created byuploading a CSV file."@@ -399,6 +457,10 @@:file (get-in multipart-params ["file" :tempfile]):action :metabase.upload/append}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/replace-csv""Replaces the contents of the table identified by `:id` with the rows of an uploaded CSV file. The table must havebeen created by uploading a CSV file."@@ -425,7 +487,12 @@(quick-task/submit-task! #(database-routing/with-database-routing-off (sync/sync-table! table))));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/sync_schema""Trigger a manual update of the schema metadata for this `Table`."[{:keys [id]} :- [:mapdiff --git a/src/metabase/warehouses_rest/api.clj b/src/metabase/warehouses_rest/api.cljindex 9a81c59948a..235128a8cba 100644--- a/src/metabase/warehouses_rest/api.clj+++ b/src/metabase/warehouses_rest/api.clj@@ -290,7 +290,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/""Fetch all `Databases`.@@ -415,7 +420,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id""Get a single Database with `id`. Optionally pass `?include=tables` or `?include=tables.fields` to include the Tablesbelonging to this database, or the Tables and Fields, respectively. If the requestor has write permissions for the@@ -493,7 +503,12 @@always-false-hsql-expr)});; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/usage_info""Get usage info for a database.Returns a map with keys are models and values are the number of entities that use this database."@@ -515,6 +530,11 @@;; we'll create another endpoint to specifically match the ID of the 'virtual' database. The `defendpoint` macro;; requires either strings or vectors for the route so we'll have to use a vector and create a regex to only;; match the virtual ID (and nothing else).+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get ["/:virtual-db/metadata" :virtual-db (re-pattern (str lib.schema.id/saved-questions-virtual-database-id))]"Endpoint that provides metadata for the Saved Questions 'virtual' database. Used for fooling the frontendand allowing it to treat the Saved Questions virtual DB just like any other database."@@ -558,7 +578,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/metadata""Get metadata about a `Database`, including all of its `Tables` and `Fields`. Returns DB, fields, and field values.By default only non-hidden tables and fields are returned. Passing include_hidden=true includes them.@@ -678,7 +703,12 @@(autocomplete-results tables fields limit)));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/autocomplete_suggestions""Return a list of autocomplete suggestions for a given `prefix`, or `substring`. Should only specify one, but`substring` will have priority if both are present.@@ -715,8 +745,12 @@;;;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case- :metabase/validate-defendpoint-query-params-use-kebab-case]}+ :metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/card_autocomplete_suggestions""Return a list of `Card` autocomplete suggestions for a given `query` in a given `Database`.@@ -736,6 +770,10 @@;;; ------------------------------------------ GET /api/database/:id/fields ------------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/fields""Get a list of all `Fields` in `Database`."[{:keys [id]} :- [:map@@ -757,6 +795,10 @@;;; ----------------------------------------- GET /api/database/:id/idfields -----------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/idfields""Get a list of all primary key `Fields` for `Database`."[{:keys [id]} :- [:map@@ -840,6 +882,10 @@(assoc :valid false))details)))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/""Add a new `Database`."[_route-params@@ -897,6 +943,10 @@{:status 400:body (dissoc details-or-error :valid)}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/validate""Validate that we can connect to a database given a set of details.";; TODO - why do we pass the DB in under the key `details`?@@ -914,7 +964,12 @@;;; --------------------------------------- POST /api/database/sample_database ----------------------------------------;; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/sample_database""Add the sample database as a new `Database`."[]@@ -937,6 +992,10 @@details(database/sensitive-fields-for-db database)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :put "/:id""Update a `Database`."[{:keys [id]} :- [:map@@ -1030,6 +1089,10 @@;;; -------------------------------------------- DELETE /api/database/:id --------------------------------------------+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :delete "/:id""Delete a `Database`."[{:keys [id]} :- [:map@@ -1049,7 +1112,12 @@;; Should somehow trigger sync-database/sync-database!;;;; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/sync_schema""Trigger a manual update of the schema metadata for this `Database`."[{:keys [id]} :- [:map@@ -1076,7 +1144,12 @@{:status :ok}))));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/dismiss_spinner""Manually set the initial sync status of the `Database` and correspondingtables to be `complete` (see #20863)"@@ -1103,7 +1176,12 @@;; Should somehow trigger cached-values/cache-field-values-for-database!;;;; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/rescan_values""Trigger a manual scan of the field values for this `Database`."[{:keys [id]} :- [:map@@ -1135,7 +1213,12 @@;; TODO - should this be something like DELETE /api/database/:id/field_values instead?;;;; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :post "/:id/discard_values""Discards all saved field values for this `Database`."[{:keys [id]} :- [:map@@ -1168,7 +1251,12 @@(current-user-can-manage-schema-metadata? database-id schema-name)));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/syncable_schemas""Returns a list of all syncable schemas found for the database `id`."[{:keys [id]} :- [:map@@ -1210,7 +1298,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/schemas""Returns a list of all the schemas with tables found for the database `id`. Excludes schemas with no tables."[{:keys [id]} :- [:map@@ -1221,6 +1314,10 @@(database-schemas id {:include-editable-data-model? include_editable_data_model:include-hidden? include_hidden}))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get ["/:virtual-db/schemas":virtual-db (re-pattern (str lib.schema.id/saved-questions-virtual-database-id))]"Returns a list of all the schemas found for the saved questions virtual database."@@ -1231,6 +1328,10 @@distinct(sort-by u/lower-case-en))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get ["/:virtual-db/datasets":virtual-db (re-pattern (str lib.schema.id/saved-questions-virtual-database-id))]"Returns a list of all the datasets found for the saved questions virtual database."@@ -1277,7 +1378,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/schema/:schema""Returns a list of Tables for the given Database `id` and `schema`"[{:keys [id schema]} :- [:map@@ -1293,7 +1399,12 @@;; TODO (Cam 10/28/25) -- fix this endpoint so it uses kebab-case for query parameters for consistency with the rest;; of the REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-query-params-use-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/schema/""Return a list of Tables for a Database whose `schema` is `nil` or an empty string."[{:keys [id]} :- [:map@@ -1304,6 +1415,10 @@(api/check-404 (seq (concat (schema-tables-list id nil include_hidden include_editable_data_model)(schema-tables-list id "" include_hidden include_editable_data_model)))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get ["/:virtual-db/schema/:schema":virtual-db (re-pattern (str lib.schema.id/saved-questions-virtual-database-id))]"Returns a list of Tables for the saved questions virtual database."@@ -1316,6 +1431,10 @@[:in :collection_id (api/check-404 (not-empty (t2/select-pks-set :model/Collection :name schema)))])])(map schema.table/card->virtual-table))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:id/healthcheck""Reports whether the database can currently connect"[{:keys [id]} :- [:map [:id ms/PositiveInt]]]@@ -1326,6 +1445,10 @@(merge err-map {:status "error"}){:status "ok"}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get ["/:virtual-db/datasets/:schema":virtual-db (re-pattern (str lib.schema.id/saved-questions-virtual-database-id))]"Returns a list of Tables for the datasets virtual database."diff --git a/src/metabase/xrays/api/automagic_dashboards.clj b/src/metabase/xrays/api/automagic_dashboards.cljindex f004d3b55a4..7a21ef720de 100644--- a/src/metabase/xrays/api/automagic_dashboards.clj+++ b/src/metabase/xrays/api/automagic_dashboards.clj@@ -69,6 +69,10 @@:error/fn (fn [_ _] (i18n/tru "value couldn''t be parsed as base64 encoded JSON"))}decode-base64-json])+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/database/:id/candidates""Return a list of candidates for automagic dashboards ordered by interestingness."[{:keys [id]} :- [:map@@ -194,6 +198,10 @@(-> (->entity entity entity-id-or-query)(automagic-dashboards.core/automagic-analysis {:show (coerce-show show)}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:entity/:entity-id-or-query""Return an automagic dashboard for entity `entity` with id `id`."[{:keys [entity entity-id-or-query]} :- [:map@@ -221,7 +229,12 @@(queries/batch-fetch-dashboard-metadata [(normalize-dashboard dashboard)])));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:entity/:entity-id-or-query/query_metadata""Return all metadata for an automagic dashboard for entity `entity` with id `id`."[{:keys [entity entity-id-or-query]} :- [:map@@ -317,7 +330,12 @@:text.align_vertical :bottom}}])}));; TODO (Cam 10/28/25) -- fix this endpoint route to use kebab-case for consistency with the rest of our REST API-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case]}+;;+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-route-uses-kebab-case+ :metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/model_index/:model-index-id/primary_key/:pk-id""Return an automagic dashboard for an entity detail specified by `entity`with id `id` and a primary key of `indexed-value`."@@ -339,6 +357,10 @@:model-index model-index:model-index-value model-index-value}))))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:entity/:entity-id-or-query/rule/:prefix/:dashboard-template""Return an automagic dashboard for entity `entity` with id `id` using dashboard-template `dashboard-template`."[{:keys [entity entity-id-or-query prefix dashboard-template]} :- [:map@@ -352,6 +374,10 @@(automagic-dashboards.core/automagic-analysis {:show (coerce-show show):dashboard-template ["table" prefix dashboard-template]})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:entity/:entity-id-or-query/cell/:cell-query""Return an automagic dashboard analyzing cell in automagic dashboard for entity `entity` defined by query`cell-query`."@@ -365,6 +391,10 @@(automagic-dashboards.core/automagic-analysis {:show (coerce-show show):cell-query (decode-base64-json cell-query)})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:entity/:entity-id-or-query/cell/:cell-query/rule/:prefix/:dashboard-template""Return an automagic dashboard analyzing cell in question with id `id` defined by query `cell-query` usingdashboard-template `dashboard-template`."@@ -381,6 +411,10 @@:dashboard-template ["table" prefix dashboard-template]:cell-query (decode-base64-json cell-query)})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:entity/:entity-id-or-query/compare/:comparison-entity/:comparison-entity-id-or-query""Return an automagic comparison dashboard for entity `entity` with id `id` compared with entity `comparison-entity`with id `comparison-entity-id-or-query.`"@@ -401,6 +435,10 @@:comparison? true})](automagic-dashboards.comparison/comparison-dashboard dashboard left right {})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:entity/:entity-id-or-query/rule/:prefix/:dashboard-template/compare/:comparison-entity/:comparison-entity-id-or-query""Return an automagic comparison dashboard for entity `entity` with id `id` using dashboard-template`dashboard-template`; compared with entity `comparison-entity` with id `comparison-entity-id-or-query.`."@@ -426,6 +464,10 @@:comparison? true})](automagic-dashboards.comparison/comparison-dashboard dashboard left right {})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:entity/:entity-id-or-query/cell/:cell-query/compare/:comparison-entity/:comparison-entity-id-or-query""Return an automagic comparison dashboard for cell in automagic dashboard for entity `entity`with id `id` defined by query `cell-query`; compared with entity `comparison-entity` with id@@ -449,6 +491,10 @@:comparison? true})](automagic-dashboards.comparison/comparison-dashboard dashboard left right {:left {:cell-query (decode-base64-json cell-query)}})))+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to+;; use our API + we will need it when we make auto-TypeScript-signature generation happen+;;+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}(api.macros/defendpoint :get "/:entity/:entity-id-or-query/cell/:cell-query/rule/:prefix/:dashboard-template/compare/:comparison-entity/:comparison-entity-id-or-query""Return an automagic comparison dashboard for cell in automagic dashboard for entity `entity`with id `id` defined by query `cell-query` using dashboard-template `dashboard-template`; compared with entity