Skip to content

[auto-build] endpoint-dox-response-schemas -> master #332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 25, 2025
+40 −5,314
Merged

[auto-build] endpoint-dox-response-schemas -> master #332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96dd6fa
[auto] adding content to endpoint-dox-response-schemas->master
Jul 22, 2025
c2fbf79
Merge remote-tracking branch 'origin/master' into endpoint-dox-respon…
escherize Jul 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 0 additions & 83 deletions _docs/master/embedding/sdk/upgrade.md
View file
Open in desktop

This file was deleted.

29 changes: 16 additions & 13 deletions _docs/master/embedding/sdk/version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,32 +15,35 @@ layout: new-docs

The SDK stable version tracks with the Metabase version.

So, for example, if you're on Metabase 55 (`0.55.x`, `1.55.x`), _any_ version 0.55.x of the @metabase/embedding-sdk-react npm package will be compatible.
So, for example, if you're on Metabase 53 (`0.53.x`, `1.53.x`), _any_ version 0.53.x of the @metabase/embedding-sdk-react npm package will be compatible.

To simplify things, we publish dist-tags for each stable Metabase version. For example, to install the latest version of the SDK compatible with Metabase 55, run:
To simplify things, we publish dist-tags for each stable Metabase version. For example, to install the latest version of the SDK compatible with Metabase 53, run:

```sh
npm install @metabase/embedding-sdk-react@55-stable
npm install @metabase/embedding-sdk-react@53-stable
```

To grab the latest version of the SDK that works with Metabase nightly builds, use the `canary` dist-tag.

## Minimum SDK version

Version 52 is the minimum version supported for the Embedded analytics SDK.
52 is the minimum version supported for the Embedded analytics SDK.

## Instances on Metabase Cloud will be pinned to a specific version
## Version pinning when using the SDK with Metabase Cloud

By default, if you're running on Metabase Cloud and using the Embedded analytics SDK, we'll pin your version to avoid breaking changes.
To pin your version of Metabase, go to **Admin settings > Settings > Embedding**. Go to the Embedded analytics SDK card and scroll to **Version pinning** and click **Request version pinning**.

Normally, Metabase Cloud upgrades your Metabase as new versions roll out so you don't have to deal with upgrades. But if you're using the SDK with Metabase Cloud, you'll want to upgrade manually to make sure your embeds don't break when you upgrade both your Metabase and your SDK version.
## Version pinning requirements

### Manually pinning your instance version on Metabase Cloud
To pin a version of Metabase, you must:

To manually pin your version of Metabase:
- Be on Metabase Cloud (obviously)
- Be on the Pro or Enterprise plans

1. Go to **Admin settings > Settings > Embedding**.
2. Go to the Embedded analytics SDK card.
3. Scroll to **Version pinning** and click **Request version pinning**.
## Why you'd want to pin your Metabase Cloud version

This will open a mailto link to our support team.
Normally, Metabase Cloud upgrades your Metabase as new versions roll out so that you don't have to deal with upgrades.

But if you're using the SDK with Metabase Cloud, you'll want to upgrade manually to make sure your embeds don't break when you upgrade both your Metabase and your SDK version.

To upgrade manually, you can pin your Metabase version so that it stays in sync with the SDK version you're using. That way you can choose when to upgrade your Metabase.
16 changes: 2 additions & 14 deletions _docs/master/installation-and-operation/upgrading-metabase.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,11 @@ redirect_from:

# Upgrading Metabase

This page covers how to upgrade to a new Metabase release.

- [Announcement posts for major releases](https://www.)
- [Changelogs](/changelog).
- [Release notes on GitHub](https://github.com/metabase/metabase/releases).
This page covers how to upgrade to a new [Metabase release](https://github.com/metabase/metabase/releases).

## Upgrading Metabase Cloud

If you're on a [Metabase Cloud](/pricing/) plan, we'll upgrade your Metabase automatically with each new release; no action needed on your end ([unless you're using the Embedded analytics SDK](#instances-using-the-embedded-analtyics-sdk-on-metabase-cloud-must-request-an-upgrade)).
If you're on a [Metabase Cloud](/pricing/) plan, we'll upgrade your Metabase automatically with each new release; no action needed on your end.

How soon we upgrade you depends on the type of release:

Expand All @@ -30,14 +26,6 @@ How soon we upgrade you depends on the type of release:

Cloud customers can request an early upgrade by emailing support at help@metabase.com. Include the URL of the Metabase you want us to upgrade.

### Instances using the Embedded analtyics SDK on Metabase Cloud must request an upgrade

If you're using the [Embedded analytics SDK](../embedding/sdk/introduction) on Metabase Cloud, we pin your version so that it doesn't upgrade automatically, as you should test the changes before upgrading.

To upgrade your Metabase, you'll need to request an upgrade by [contacting support](/help-premium).

See our [upgrade guide for the Embedded analytics SDK](../embedding/sdk/upgrade).

## Upgrading a self-hosted Metabase

Here are the steps for upgrading to a new Metabase version (major or minor):
Expand Down
Loading