Skip to content
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

Jump to bottom

Update API Changelog for trash #42480

Closed
wants to merge 1 commit into from
Closed

Update API Changelog for trash #42480

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/developers-guide/api-changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@ title: API changelog

## Metabase 0.50.0

- `PUT /api/dashboard/:id`, `PUT /api/card/:id`, and `PUT /api/collection/:id`

When setting `archived` to `true`, the Dashboard, Card, or Collection will be automatically moved to the Trash
collection, a special collection that holds all archived items.

When setting `archived` to `false`, you may optionally also provide a `collection_id` (for Dashboards or Cards) or a
`parent_id` (for Collections). In this case, the entity will be re-parented to the specified Collection when it is
moved from the Trash. If a new `collection_id` or `parent_id` is not provided, the entity will be moved back to its
original location if possible. If this is not possible (for example, the original location is also in the Trash) an
error will occur.

- `/api/metric`

The `/api/metric` endpoints has been renamed to `/api/legacy-metric` to reflect that fact it will not be used for the new version of metrics. The new version uses the `/api/card` endpoints.
Expand All @@ -30,6 +41,12 @@ title: API changelog

# Additions to the API interface

## Metabase 0.50.0

- `GET /api/collection/:id/items`

An additional boolean column, `archived`, has been added to results.

## Metabase 0.49.5
NOTE: These endpoint changes were added in 0.49.3, and a bug in `GET /api/embed/card/:token/query/:export-format` was fixed in 0.49.5.

Expand Down