Breaking (!) API changes for v2 API, May 1 to May 8

This week, the mittwald API underwent several changes, including the removal of an API path without deprecation, the introduction of new optional request parameters, and updates to operation IDs, alongside modifications to response statuses for user account deletion.

Breaking changes

This document contains changes that can under certain circumstances be considered breaking. Please review the changes carefully.

While we generally strive to avoid breaking changes in accordance with our API stability guarantees, we occasionally might perform changes that would be considered breaking in the strictest sense of the term, but we do not consider as breaking in a practical sense. We will always provide ample notice and documentation for such changes.

Summary

• The API path for the operation POST /v2/services/{accessKeyId}/actions/authenticate has been removed without deprecation, which is a breaking change.
• A new optional request parameter sortOrder has been added to the GET /v2/app-installations operation, which lists AppInstallations that a user has access to.
• A new optional request property messageContent has been added to the POST /v2/conversations operation, which creates a conversation.
• The API operation ID backup-get-project-backup-database-dumps-v2-experimental has been removed and replaced with backup-get-project-backup-database-dumps for the GET /v2/project-backups/{projectBackupId}/database-dumps operation.
• The API operation ID backup-request-project-backup-restore-v2-experimental has been removed and replaced with backup-request-project-backup-restore for the POST /v2/project-backups/{projectBackupId}/restore operation.
• A new optional request parameter sortOrder has been added to the GET /v2/projects/{projectId}/app-installations operation, which lists AppInstallations belonging to a Project.
• A new optional request parameter runningBackupsOnly has been added to the GET /v2/projects/{projectId}/backups operation, which lists Backups belonging to a Project.
• A non-success response with the status 412 has been added to the DELETE /v2/users/self operation, which deletes your account and all your personal data.
• The non-success response with the status 409 has been removed from the DELETE /v2/users/self operation.

Disclaimer: This summary is AI-generated. If you find any discrepancies, please refer to the detailed changes below.

Detailed changes

Changes in "servicetoken-authenticate-service"

• ⚠️ Breaking: api path removed without deprecation

For details, refer to the unknown operation servicetoken-authenticate-service endpoint.

Changes in "List app installations that a user has access to"

• added the new optional 'query' request parameter 'sortOrder'

For details, refer to the GET/v2/app-installations/ endpoint.

Changes in "Create a conversation"

• added the new optional request property 'messageContent'

For details, refer to the POST/v2/conversations/ endpoint.

Changes in "backup-get-project-backup-database-dumps-v2-experimental"

• api operation id 'backup-get-project-backup-database-dumps-v2-experimental' removed and replaced with 'backup-get-project-backup-database-dumps'

For details, refer to the unknown operation backup-get-project-backup-database-dumps-v2-experimental endpoint.

Changes in "backup-request-project-backup-restore-v2-experimental"

• api operation id 'backup-request-project-backup-restore-v2-experimental' removed and replaced with 'backup-request-project-backup-restore'

For details, refer to the unknown operation backup-request-project-backup-restore-v2-experimental endpoint.

Changes in "List app installations belonging to a Project"

• added the new optional 'query' request parameter 'sortOrder'

For details, refer to the GET/v2/projects/{projectId}/app-installations/ endpoint.

Changes in "List Backups belonging to a Project"

• added the new optional 'query' request parameter 'runningBackupsOnly'

For details, refer to the GET/v2/projects/{projectId}/backups/ endpoint.

Changes in "Delete your account and all your personal data"

• added the non-success response with the status '412'

• removed the non-success response with the status '409'

For details, refer to the DELETE/v2/users/self/ endpoint.

Client package releases

mittwald JavaScript SDK Release 4.361.0

The mittwald JavaScript SDK has been updated to version 4.361.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub.

mittwald JavaScript SDK Release 4.360.1

The mittwald JavaScript SDK has been updated to version 4.360.1. This release is a version bump only for the package root, with no additional changes or features introduced. For more details, you can view the release on GitHub: mittwald JavaScript SDK 4.360.1.

mittwald JavaScript SDK Release 4.360.0

The mittwald JavaScript SDK has been updated to version 4.360.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub.

mittwald JavaScript SDK Release 4.359.0

The mittwald JavaScript SDK has been updated to version 4.359.0. This release includes the following feature:

• Updated the generated client to enhance functionality and performance (commit 0d4a4f8).

For more details, please visit the release page.

mittwald JavaScript SDK Release 4.358.0

The mittwald JavaScript SDK has been updated to version 4.358.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub here.

mittwald JavaScript SDK Release 4.357.0

The mittwald JavaScript SDK has been updated to version 4.357.0. This release includes the following feature:

• Updated generated client (commit 3f7dc58)

For more details, view the release on GitHub: mittwald JavaScript SDK 4.357.0.

mittwald JavaScript SDK Release 4.356.1

The mittwald JavaScript SDK version 4.356.1 has been released. This update primarily addresses several security vulnerabilities, specifically CVE-2026-42033, CVE-2026-42035, CVE-2026-42043, and CVE-2026-42264. These fixes enhance the security and stability of the SDK. For more details, you can view the release on GitHub here.

mittwald JavaScript SDK Release 4.356.0

The mittwald JavaScript SDK has been updated to version 4.356.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub here.