v2.3.1

This is a bugfix release to solve issues with open database connections in the background task worker.

v2.3.0

Gramps Query Language filter

This realease adds the option to filter the object endpoints by a GQL (Gramps Query Language) query string, e.g. /api/people?gql=myquery. GQL is a new alternative to conventional Gramps filters which uses a query syntax inspired by SQL.

v2.2.1

This patch release fixes an issue with v2.2.0 that caused the transaction history endpoint to not correctly filter by tree ID when using the sharedpostgresql backend.

v2.2.0

New endpoint for database change history

This release features a new endpoint /transactions/history/ that allows accessing past database transactions, i.e. edits, additions, and deletions. This is made possible by a new custom undo database implementation leveraging a new feature in Gramps 5.2.

The endpoint can be accessed by users with ViewPrivate permissions.

Note that the user names and full names of users that have edited the database will be visible to all users who can access this endpoint.

v2.1.0

New endpoint to delete all objects

This release introduces a new endpoint /objects/delete/ that allows to delete all objects in the tree; the optional argument namespaces can be used to restrict deletion to certain object types.

To add an additional layer of protection for this potentially dangerous feature, the concept of token freshness is introduced: only "fresh" tokens that were obtained by direct authentication, not from a refresh token, are accepted for this operation, so users may have to authenticate again.

Change to trees endpoint

The /trees/ endpoint, that is useful particularly in multi-tree deployments, now also gives access to the enabled flag to check if a given tree is disabled or not.

v2.0.0

Welcome Gramps 5.2 & Gramps Web API 2.0!

This is the first backwards-incompatible release of Gramps Web API because it depends on Gramps 5.2 rather than Gramps 5.1.

Gramps 5.2 was released on February 23, 2024, and brings a host of improvements. However, it also contains a change in the database schema, which means that all existing database must be upgraded to the new schema - this applies both to Gramps Web and Gramps Desktop.

Please back up your tree before you upgrade. Detailed instructions for upgrading can be found at https://www.grampsweb.org/setup/v2/.

Change to Docker images

One of the improvements in Gramps 5.2 is that in can be installed via pip like any other Python package now. This makes it easier to install Gramps Web API and we have removed the dependency on the Gramps base Docker image.

Progress for background tasks

Apart from the change to Gramps 5.2, this release also brings a useful new feature: the /tasks/<task-id> endpoint now reports progress status for all background tasks.

v1.6.0

This release adds a new endpoint to check & repair a database, improves the handling of media imports, and fixes a few issues.

Check & repair database

Gramps desktop has a "check & repair" tool that checks for issues with a Gramps database and fixes some of them automatically. This release brings this tool to Gramps Web API as well, in the form of a simple new endpoint /trees/<tree_id>/repair.

Import media even when checksums are missing

The "import media archive" endpoint so far relied on media objects having correct checksums. However, there are cases, e.g. Gedcom import, when media objects would be created without checksums. From this version onwards, media files from an uploaded ZIP file will be correctly imported if either the checksum is present and matches (existing behaviour) or if the checksum is empty and the relative path of the file in the ZIP archive matches the relative path of the media object (new behaviour).

Fixes & improvements to user registration

• New configuration option DISABLE_REGISTRATION to completely disable registration of new users
• So far, user registration was automatically disabled if no user of type "owner" existed. This was changed now to also allow registration if a user of type "administrator" exists, if Gramps Web API is deployed as single-tree instance.
• On registration of a new user, so far an e-mail was sent to all tree owners. Now, an e-mail is also sent to administrators if it is a single-tree instance.

Other improvements

An issue causing sever errors when generating reports has been fixed.

v1.5.1

Changes in this maintenance release:

• Catch handle errors in extended attributes (#477)
• Add FilterRules plugin to the docker image (#476)

Moreover, the repository has been renamed from gramps-webapi to gramps-web-api, see #473 for the rationale. The project name and Python package & module names do not change.

v1.5.0

This new release brings two new API features.

Edit bookmarks

The /api/bookmarks/ endpoint was only able to list existing bookmarks. This release adds edit capabilities by introducing the put (for adding a bookmark) and delete endpoint /api/bookmarks/{class}/{handle}.

Admin access to tree quotas

So far, in a multi-tree deployment, the server admin was able to create trees and modify their quotas, but not view them. This release adds rights for the server admin to view the following tree details: ID, name, people quota and usage, media quota and usage. This data is typically necessary for an administrator to manage the server.

v1.4.2

This patch release fixes an issue with the PUT method of the /media/<handle>/file endpoint when using object storage for media files.