Skip to content

Commit 432b322

Browse files
github-automation-metabaseMetabase Docs bot
github-automation-metabase
and
Metabase Docs bot
authored
[auto] adding content to master->master (#822)
Co-authored-by: Metabase Docs bot <[email protected]>
1 parent dcd2c36 commit 432b322

File tree

10 files changed

+627
-34
lines changed

10 files changed

+627
-34
lines changed

‎_docs/master/api.json‎

Lines changed: 292 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,18 @@
245245
} ]
246246
},
247247
"mbql.clause.coalesce" : { },
248+
"mbql.clause.collate" : {
249+
"type" : "array",
250+
"prefixItems" : [ {
251+
"const" : "collate"
252+
}, {
253+
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
254+
}, {
255+
"$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
256+
}, {
257+
"type" : "string"
258+
} ]
259+
},
248260
"mbql.clause.concat" : { },
249261
"mbql.clause.contains" : { },
250262
"mbql.clause.convert-timezone" : { },
@@ -3259,6 +3271,114 @@
32593271
"description" : "value must be a valid attribute remappings map (attribute name -> remapped name)",
32603272
"optional" : true
32613273
},
3274+
"metabase-enterprise.support-access-grants.schema.create-grant-request" : {
3275+
"description" : "Schema for POST /api/ee/support-access-grants request body.",
3276+
"type" : "object",
3277+
"properties" : {
3278+
"grant_duration_minutes" : {
3279+
"type" : "integer",
3280+
"minimum" : 1,
3281+
"maximum" : 10080
3282+
},
3283+
"notes" : {
3284+
"type" : "string",
3285+
"minLength" : 1,
3286+
"maxLength" : 255
3287+
},
3288+
"ticket_number" : {
3289+
"type" : "string",
3290+
"minLength" : 1,
3291+
"maxLength" : 100
3292+
}
3293+
},
3294+
"required" : [ "grant_duration_minutes" ]
3295+
},
3296+
"metabase-enterprise.support-access-grants.schema.current-grant-response" : {
3297+
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response",
3298+
"description" : "Schema for GET /api/ee/support-access-grants/current response.",
3299+
"optional" : true
3300+
},
3301+
"metabase-enterprise.support-access-grants.schema.grant-response" : {
3302+
"description" : "Schema for a support access grant object in API responses.",
3303+
"type" : "object",
3304+
"properties" : {
3305+
"user_id" : {
3306+
"description" : "value must be an integer greater than zero.",
3307+
"type" : "integer",
3308+
"minimum" : 1
3309+
},
3310+
"token" : {
3311+
"type" : "string"
3312+
},
3313+
"user_name" : {
3314+
"type" : "string"
3315+
},
3316+
"user_email" : {
3317+
"type" : "string"
3318+
},
3319+
"grant_end_timestamp" : {
3320+
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
3321+
},
3322+
"revoked_at" : {
3323+
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
3324+
},
3325+
"revoked_by_user_id" : {
3326+
"description" : "value must be an integer greater than zero.",
3327+
"type" : "integer",
3328+
"minimum" : 1
3329+
},
3330+
"id" : {
3331+
"description" : "value must be an integer greater than zero.",
3332+
"type" : "integer",
3333+
"minimum" : 1
3334+
},
3335+
"ticket_number" : {
3336+
"type" : "string"
3337+
},
3338+
"updated_at" : {
3339+
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
3340+
},
3341+
"created_at" : {
3342+
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
3343+
},
3344+
"notes" : {
3345+
"type" : "string"
3346+
},
3347+
"grant_start_timestamp" : {
3348+
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
3349+
}
3350+
},
3351+
"required" : [ "id", "user_id", "grant_start_timestamp", "grant_end_timestamp", "created_at", "updated_at" ]
3352+
},
3353+
"metabase-enterprise.support-access-grants.schema.list-grants-response" : {
3354+
"description" : "Schema for GET /api/ee/support-access-grants response (paginated list).",
3355+
"type" : "object",
3356+
"properties" : {
3357+
"data" : {
3358+
"type" : "array",
3359+
"items" : {
3360+
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
3361+
}
3362+
},
3363+
"limit" : {
3364+
"description" : "value must be an integer greater than zero.",
3365+
"type" : "integer",
3366+
"minimum" : 1
3367+
},
3368+
"offset" : {
3369+
"type" : "integer",
3370+
"minimum" : 0
3371+
},
3372+
"total" : {
3373+
"type" : "integer",
3374+
"minimum" : 0
3375+
}
3376+
},
3377+
"required" : [ "data", "total", "limit", "offset" ]
3378+
},
3379+
"metabase-enterprise.support-access-grants.schema.timestamp" : {
3380+
"anyOf" : [ { }, { } ]
3381+
},
32623382
"metabase-enterprise.transforms.api.run-trigger" : {
32633383
"type" : "string",
32643384
"enum" : [ "none", "global-schedule" ]
@@ -5183,6 +5303,8 @@
51835303
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.text"
51845304
}, {
51855305
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.split-part"
5306+
}, {
5307+
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.collate"
51865308
} ]
51875309
},
51885310
"metabase.legacy-mbql.schema.StringExpressionArg" : {
@@ -5397,6 +5519,10 @@
53975519
"description" : "schema for a valid MBQL 4 :coalesce clause",
53985520
"allOf" : [ ]
53995521
},
5522+
"metabase.legacy-mbql.schema.collate" : {
5523+
"description" : "schema for a valid MBQL 4 :collate clause",
5524+
"allOf" : [ ]
5525+
},
54005526
"metabase.legacy-mbql.schema.concat" : {
54015527
"description" : "schema for a valid MBQL 4 :concat clause",
54025528
"allOf" : [ ]
@@ -6830,6 +6956,8 @@
68306956
"$ref" : "#/components/schemas/mbql.clause.ceil"
68316957
}, {
68326958
"$ref" : "#/components/schemas/mbql.clause.coalesce"
6959+
}, {
6960+
"$ref" : "#/components/schemas/mbql.clause.collate"
68336961
}, {
68346962
"$ref" : "#/components/schemas/mbql.clause.concat"
68356963
}, {
@@ -9704,6 +9832,7 @@
97049832
"description" : "Server error response"
97059833
}
97069834
},
9835+
"deprecated" : true,
97079836
"tags" : [ "/api/activity" ]
97089837
}
97099838
},
@@ -12394,10 +12523,6 @@
1239412523
"description" : "value must be an integer greater than zero.",
1239512524
"type" : "integer",
1239612525
"minimum" : 1
12397-
},
12398-
"type" : {
12399-
"type" : "string",
12400-
"enum" : [ "remote-synced" ]
1240112526
}
1240212527
},
1240312528
"required" : [ "name" ]
@@ -13109,6 +13234,7 @@
1310913234
"description" : "Server error response"
1311013235
}
1311113236
},
13237+
"deprecated" : true,
1311213238
"tags" : [ "/api/dashboard" ]
1311313239
},
1311413240
"post" : {
@@ -21087,6 +21213,149 @@
2108721213
"tags" : [ "/api/ee/stale" ]
2108821214
}
2108921215
},
21216+
"/api/ee/support-access-grant/" : {
21217+
"post" : {
21218+
"summary" : "POST /api/ee/support-access-grant/",
21219+
"description" : "Create a new support access grant.\n\n Requires superuser permissions. Only one active grant can exist at a time.",
21220+
"parameters" : [ ],
21221+
"responses" : {
21222+
"2XX" : {
21223+
"description" : "Schema for a support access grant object in API responses.",
21224+
"content" : {
21225+
"application/json" : {
21226+
"schema" : {
21227+
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
21228+
}
21229+
}
21230+
}
21231+
},
21232+
"4XX" : {
21233+
"description" : "Client error response"
21234+
},
21235+
"5XX" : {
21236+
"description" : "Server error response"
21237+
}
21238+
},
21239+
"requestBody" : {
21240+
"content" : {
21241+
"application/json" : {
21242+
"schema" : {
21243+
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.create-grant-request"
21244+
}
21245+
}
21246+
}
21247+
},
21248+
"tags" : [ "/api/ee/support-access-grant" ]
21249+
},
21250+
"get" : {
21251+
"summary" : "GET /api/ee/support-access-grant/",
21252+
"description" : "List support access grants with optional filtering and pagination.\n\n Requires superuser permissions.\n\n Query parameters:\n - ticket-number: Filter by ticket number\n - user-id: Filter by user who created the grant\n - include-revoked: Include revoked grants (default false)",
21253+
"parameters" : [ {
21254+
"in" : "query",
21255+
"name" : "ticket-number",
21256+
"required" : false,
21257+
"schema" : {
21258+
"type" : "string"
21259+
}
21260+
}, {
21261+
"in" : "query",
21262+
"name" : "user-id",
21263+
"required" : false,
21264+
"schema" : {
21265+
"type" : "integer",
21266+
"minimum" : 1
21267+
},
21268+
"description" : "value must be an integer greater than zero."
21269+
}, {
21270+
"in" : "query",
21271+
"name" : "include-revoked",
21272+
"required" : false,
21273+
"schema" : {
21274+
"type" : "boolean"
21275+
}
21276+
} ],
21277+
"responses" : {
21278+
"2XX" : {
21279+
"description" : "Schema for GET /api/ee/support-access-grants response (paginated list).",
21280+
"content" : {
21281+
"application/json" : {
21282+
"schema" : {
21283+
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.list-grants-response"
21284+
}
21285+
}
21286+
}
21287+
},
21288+
"4XX" : {
21289+
"description" : "Client error response"
21290+
},
21291+
"5XX" : {
21292+
"description" : "Server error response"
21293+
}
21294+
},
21295+
"tags" : [ "/api/ee/support-access-grant" ]
21296+
}
21297+
},
21298+
"/api/ee/support-access-grant/current" : {
21299+
"get" : {
21300+
"summary" : "GET /api/ee/support-access-grant/current",
21301+
"description" : "Get the currently active support access grant, if one exists.\n\n Requires superuser permissions.",
21302+
"parameters" : [ ],
21303+
"responses" : {
21304+
"2XX" : {
21305+
"description" : "Schema for GET /api/ee/support-access-grants/current response.",
21306+
"content" : {
21307+
"application/json" : {
21308+
"schema" : {
21309+
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.current-grant-response"
21310+
}
21311+
}
21312+
}
21313+
},
21314+
"4XX" : {
21315+
"description" : "Client error response"
21316+
},
21317+
"5XX" : {
21318+
"description" : "Server error response"
21319+
}
21320+
},
21321+
"tags" : [ "/api/ee/support-access-grant" ]
21322+
}
21323+
},
21324+
"/api/ee/support-access-grant/{id}/revoke" : {
21325+
"put" : {
21326+
"summary" : "PUT /api/ee/support-access-grant/{id}/revoke",
21327+
"description" : "Revoke an existing support access grant.\n\n Requires superuser permissions. Any admin can revoke any grant.",
21328+
"parameters" : [ {
21329+
"in" : "path",
21330+
"name" : "id",
21331+
"required" : true,
21332+
"schema" : {
21333+
"type" : "integer",
21334+
"minimum" : 1
21335+
},
21336+
"description" : "value must be an integer greater than zero."
21337+
} ],
21338+
"responses" : {
21339+
"2XX" : {
21340+
"description" : "Schema for a support access grant object in API responses.",
21341+
"content" : {
21342+
"application/json" : {
21343+
"schema" : {
21344+
"$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
21345+
}
21346+
}
21347+
}
21348+
},
21349+
"4XX" : {
21350+
"description" : "Client error response"
21351+
},
21352+
"5XX" : {
21353+
"description" : "Server error response"
21354+
}
21355+
},
21356+
"tags" : [ "/api/ee/support-access-grant" ]
21357+
}
21358+
},
2109021359
"/api/ee/transform-job/" : {
2109121360
"post" : {
2109221361
"summary" : "POST /api/ee/transform-job/",
@@ -25813,6 +26082,25 @@
2581326082
"tags" : [ "/api/preview_embed" ]
2581426083
}
2581526084
},
26085+
"/api/preview_embed/dashboard/{token}/params/{param-key}/search/{prefix}" : {
26086+
"get" : {
26087+
"summary" : "GET /api/preview_embed/dashboard/{token}/params/{param-key}/search/{prefix}",
26088+
"description" : "Embedded version of chain filter search endpoint.",
26089+
"parameters" : [ ],
26090+
"responses" : {
26091+
"2XX" : {
26092+
"description" : "Successful response"
26093+
},
26094+
"4XX" : {
26095+
"description" : "Client error response"
26096+
},
26097+
"5XX" : {
26098+
"description" : "Server error response"
26099+
}
26100+
},
26101+
"tags" : [ "/api/preview_embed" ]
26102+
}
26103+
},
2581626104
"/api/preview_embed/dashboard/{token}/params/{param-key}/values" : {
2581726105
"get" : {
2581826106
"summary" : "GET /api/preview_embed/dashboard/{token}/params/{param-key}/values",

‎_docs/master/embedding/sdk/api/IconName.html‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)