Skip to content

Commit 2718d61

Browse files
github-automation-metabaseMetabase Docs bot
github-automation-metabase
and
Metabase Docs bot
authored
[auto] adding content to docs/auto-update-master-2025-10-03-013147->master (#721)
Co-authored-by: Metabase Docs bot <[email protected]>
1 parent daee264 commit 2718d61

File tree

2 files changed

+296
-6
lines changed

2 files changed

+296
-6
lines changed

‎_docs/master/api.html‎

Lines changed: 148 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,52 @@
211211
"$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-expression"
212212
} ]
213213
},
214+
"metabase-enterprise.dependencies.api.card-body" : {
215+
"type" : "object",
216+
"properties" : {
217+
"dataset_query" : {
218+
"description" : "Value must be a map.",
219+
"type" : "object",
220+
"properties" : { }
221+
},
222+
"id" : {
223+
"description" : "value must be an integer greater than zero.",
224+
"type" : "integer",
225+
"minimum" : 1
226+
},
227+
"result_metadata" : {
228+
"$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
229+
},
230+
"type" : {
231+
"$ref" : "#/components/schemas/metabase.queries.schema.card-type"
232+
}
233+
},
234+
"required" : [ "id" ]
235+
},
236+
"metabase-enterprise.dependencies.api.transform-body" : {
237+
"type" : "object",
238+
"properties" : {
239+
"id" : {
240+
"description" : "value must be an integer greater than zero.",
241+
"type" : "integer",
242+
"minimum" : 1
243+
},
244+
"name" : {
245+
"type" : "string"
246+
},
247+
"source" : {
248+
"description" : "Value must be a map.",
249+
"type" : "object",
250+
"properties" : { }
251+
},
252+
"target" : {
253+
"description" : "Value must be a map.",
254+
"type" : "object",
255+
"properties" : { }
256+
}
257+
},
258+
"required" : [ "id" ]
259+
},
214260
"metabase-enterprise.metabot-v3.client.schema.message" : {
215261
"type" : "object",
216262
"properties" : {
@@ -4434,8 +4480,8 @@
44344480
"optional" : true
44354481
},
44364482
"metabase.lib.schema.metadata.desired-column-alias" : {
4437-
"type" : "string",
4438-
"minLength" : 1
4483+
"description" : "Name we should use as a column alias for a column in this stage of a query. The desired column alias in stage N\n becomes the source column alias in stage N+1. The right-hand side (RHS) in\n\n SELECT lhs AS rhs",
4484+
"type" : "string"
44394485
},
44404486
"metabase.lib.schema.metadata.fingerprint..fingerprint.global" : {
44414487
"description" : "Fingerprint values that Fields of all types should have.",
@@ -4714,7 +4760,8 @@
47144760
"optional" : true
47154761
},
47164762
"metabase.lib.schema.metadata.source-column-alias" : {
4717-
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
4763+
"description" : "Name for a column as returned/projected by the previous stage of the query or source Table/source Card. The\n left-hand side (LHS) of\n\n SELECT lhs AS rhs",
4764+
"type" : "string"
47184765
},
47194766
"metabase.lib.schema.middleware-options.middleware-options" : {
47204767
"description" : "Additional options that can be used to toggle middleware on or off.",
@@ -13330,6 +13377,104 @@
1333013377
"tags" : [ "/api/ee/database-routing" ]
1333113378
}
1333213379
},
13380+
"/api/ee/dependencies/check_card" : {
13381+
"post" : {
13382+
"summary" : "POST /api/ee/dependencies/check_card",
13383+
"description" : "Check a proposed edit to a card, and return the card IDs for those cards this edit will break.",
13384+
"parameters" : [ ],
13385+
"responses" : {
13386+
"2XX" : {
13387+
"description" : "Successful response"
13388+
},
13389+
"4XX" : {
13390+
"description" : "Client error response"
13391+
},
13392+
"5XX" : {
13393+
"description" : "Server error response"
13394+
}
13395+
},
13396+
"requestBody" : {
13397+
"content" : {
13398+
"application/json" : {
13399+
"schema" : {
13400+
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.card-body"
13401+
}
13402+
}
13403+
}
13404+
},
13405+
"tags" : [ "/api/ee/dependencies" ]
13406+
}
13407+
},
13408+
"/api/ee/dependencies/check_snippet" : {
13409+
"post" : {
13410+
"summary" : "POST /api/ee/dependencies/check_snippet",
13411+
"description" : "Check a proposed edit to a native snippet, and return the cards, etc. which will be broken.",
13412+
"parameters" : [ ],
13413+
"responses" : {
13414+
"2XX" : {
13415+
"description" : "Successful response"
13416+
},
13417+
"4XX" : {
13418+
"description" : "Client error response"
13419+
},
13420+
"5XX" : {
13421+
"description" : "Server error response"
13422+
}
13423+
},
13424+
"requestBody" : {
13425+
"content" : {
13426+
"application/json" : {
13427+
"schema" : {
13428+
"type" : "object",
13429+
"properties" : {
13430+
"content" : {
13431+
"type" : "string"
13432+
},
13433+
"id" : {
13434+
"description" : "value must be an integer greater than zero.",
13435+
"type" : "integer",
13436+
"minimum" : 1
13437+
},
13438+
"name" : {
13439+
"description" : "snippet names cannot include '}' or start with spaces"
13440+
}
13441+
},
13442+
"required" : [ "id" ]
13443+
}
13444+
}
13445+
}
13446+
},
13447+
"tags" : [ "/api/ee/dependencies" ]
13448+
}
13449+
},
13450+
"/api/ee/dependencies/check_transform" : {
13451+
"post" : {
13452+
"summary" : "POST /api/ee/dependencies/check_transform",
13453+
"description" : "Check a proposed edit to a transform, and return the card, transform, etc. IDs for things that will break.",
13454+
"parameters" : [ ],
13455+
"responses" : {
13456+
"2XX" : {
13457+
"description" : "Successful response"
13458+
},
13459+
"4XX" : {
13460+
"description" : "Client error response"
13461+
},
13462+
"5XX" : {
13463+
"description" : "Server error response"
13464+
}
13465+
},
13466+
"requestBody" : {
13467+
"content" : {
13468+
"application/json" : {
13469+
"schema" : {
13470+
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.transform-body"
13471+
}
13472+
}
13473+
}
13474+
},
13475+
"tags" : [ "/api/ee/dependencies" ]
13476+
}
13477+
},
1333313478
"/api/ee/document/" : {
1333413479
"get" : {
1333513480
"summary" : "GET /api/ee/document/",

‎_site/docs/master/api.html‎

Lines changed: 148 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,52 @@
299299
"$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-expression"
300300
} ]
301301
},
302+
"metabase-enterprise.dependencies.api.card-body" : {
303+
"type" : "object",
304+
"properties" : {
305+
"dataset_query" : {
306+
"description" : "Value must be a map.",
307+
"type" : "object",
308+
"properties" : { }
309+
},
310+
"id" : {
311+
"description" : "value must be an integer greater than zero.",
312+
"type" : "integer",
313+
"minimum" : 1
314+
},
315+
"result_metadata" : {
316+
"$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
317+
},
318+
"type" : {
319+
"$ref" : "#/components/schemas/metabase.queries.schema.card-type"
320+
}
321+
},
322+
"required" : [ "id" ]
323+
},
324+
"metabase-enterprise.dependencies.api.transform-body" : {
325+
"type" : "object",
326+
"properties" : {
327+
"id" : {
328+
"description" : "value must be an integer greater than zero.",
329+
"type" : "integer",
330+
"minimum" : 1
331+
},
332+
"name" : {
333+
"type" : "string"
334+
},
335+
"source" : {
336+
"description" : "Value must be a map.",
337+
"type" : "object",
338+
"properties" : { }
339+
},
340+
"target" : {
341+
"description" : "Value must be a map.",
342+
"type" : "object",
343+
"properties" : { }
344+
}
345+
},
346+
"required" : [ "id" ]
347+
},
302348
"metabase-enterprise.metabot-v3.client.schema.message" : {
303349
"type" : "object",
304350
"properties" : {
@@ -4522,8 +4568,8 @@
45224568
"optional" : true
45234569
},
45244570
"metabase.lib.schema.metadata.desired-column-alias" : {
4525-
"type" : "string",
4526-
"minLength" : 1
4571+
"description" : "Name we should use as a column alias for a column in this stage of a query. The desired column alias in stage N\n becomes the source column alias in stage N+1. The right-hand side (RHS) in\n\n SELECT lhs AS rhs",
4572+
"type" : "string"
45274573
},
45284574
"metabase.lib.schema.metadata.fingerprint..fingerprint.global" : {
45294575
"description" : "Fingerprint values that Fields of all types should have.",
@@ -4802,7 +4848,8 @@
48024848
"optional" : true
48034849
},
48044850
"metabase.lib.schema.metadata.source-column-alias" : {
4805-
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
4851+
"description" : "Name for a column as returned/projected by the previous stage of the query or source Table/source Card. The\n left-hand side (LHS) of\n\n SELECT lhs AS rhs",
4852+
"type" : "string"
48064853
},
48074854
"metabase.lib.schema.middleware-options.middleware-options" : {
48084855
"description" : "Additional options that can be used to toggle middleware on or off.",
@@ -13418,6 +13465,104 @@
1341813465
"tags" : [ "/api/ee/database-routing" ]
1341913466
}
1342013467
},
13468+
"/api/ee/dependencies/check_card" : {
13469+
"post" : {
13470+
"summary" : "POST /api/ee/dependencies/check_card",
13471+
"description" : "Check a proposed edit to a card, and return the card IDs for those cards this edit will break.",
13472+
"parameters" : [ ],
13473+
"responses" : {
13474+
"2XX" : {
13475+
"description" : "Successful response"
13476+
},
13477+
"4XX" : {
13478+
"description" : "Client error response"
13479+
},
13480+
"5XX" : {
13481+
"description" : "Server error response"
13482+
}
13483+
},
13484+
"requestBody" : {
13485+
"content" : {
13486+
"application/json" : {
13487+
"schema" : {
13488+
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.card-body"
13489+
}
13490+
}
13491+
}
13492+
},
13493+
"tags" : [ "/api/ee/dependencies" ]
13494+
}
13495+
},
13496+
"/api/ee/dependencies/check_snippet" : {
13497+
"post" : {
13498+
"summary" : "POST /api/ee/dependencies/check_snippet",
13499+
"description" : "Check a proposed edit to a native snippet, and return the cards, etc. which will be broken.",
13500+
"parameters" : [ ],
13501+
"responses" : {
13502+
"2XX" : {
13503+
"description" : "Successful response"
13504+
},
13505+
"4XX" : {
13506+
"description" : "Client error response"
13507+
},
13508+
"5XX" : {
13509+
"description" : "Server error response"
13510+
}
13511+
},
13512+
"requestBody" : {
13513+
"content" : {
13514+
"application/json" : {
13515+
"schema" : {
13516+
"type" : "object",
13517+
"properties" : {
13518+
"content" : {
13519+
"type" : "string"
13520+
},
13521+
"id" : {
13522+
"description" : "value must be an integer greater than zero.",
13523+
"type" : "integer",
13524+
"minimum" : 1
13525+
},
13526+
"name" : {
13527+
"description" : "snippet names cannot include '}' or start with spaces"
13528+
}
13529+
},
13530+
"required" : [ "id" ]
13531+
}
13532+
}
13533+
}
13534+
},
13535+
"tags" : [ "/api/ee/dependencies" ]
13536+
}
13537+
},
13538+
"/api/ee/dependencies/check_transform" : {
13539+
"post" : {
13540+
"summary" : "POST /api/ee/dependencies/check_transform",
13541+
"description" : "Check a proposed edit to a transform, and return the card, transform, etc. IDs for things that will break.",
13542+
"parameters" : [ ],
13543+
"responses" : {
13544+
"2XX" : {
13545+
"description" : "Successful response"
13546+
},
13547+
"4XX" : {
13548+
"description" : "Client error response"
13549+
},
13550+
"5XX" : {
13551+
"description" : "Server error response"
13552+
}
13553+
},
13554+
"requestBody" : {
13555+
"content" : {
13556+
"application/json" : {
13557+
"schema" : {
13558+
"$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.transform-body"
13559+
}
13560+
}
13561+
}
13562+
},
13563+
"tags" : [ "/api/ee/dependencies" ]
13564+
}
13565+
},
1342113566
"/api/ee/document/" : {
1342213567
"get" : {
1342313568
"summary" : "GET /api/ee/document/",

0 commit comments

Comments
 (0)