Breaking (!) API changes for v2 API, December 5, 2024

On December 5, 2024, the mittwald API introduced several updates, including the removal of the default value for the 'limit' request parameter in the article listing endpoint, and the addition of required properties to the responses for MySQL user-related endpoints.

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 default value '1000.00' for the 'query' request parameter 'limit' has been removed from the GET /v2/articles operation. This is a breaking change.
• The required property '/items/status' has been added to the response with the '200' status for the GET /v2/mysql-databases/{mysqlDatabaseId}/users operation.
• The required property '/items/statusSetAt' has been added to the response with the '200' status for the GET /v2/mysql-databases/{mysqlDatabaseId}/users operation.
• The required property 'status' has been added to the response with the '200' status for the GET /v2/mysql-users/{mysqlUserId} operation.
• The required property 'statusSetAt' has been added to the response with the '200' status for the GET /v2/mysql-users/{mysqlUserId} operation.

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

Detailed changes

Changes in "List Articles"

• ⚠️ Breaking: for the 'query' request parameter 'limit', default value '1000.00' was removed

For details, refer to the GET/v2/articles/ endpoint.

Changes in "List MySQL users belonging to a Database"

• added the required property '/items/status' to the response with the '200' status

• added the required property '/items/statusSetAt' to the response with the '200' status

For details, refer to the GET/v2/mysql-databases/{mysqlDatabaseId}/users/ endpoint.

Changes in "Get a MySQL user"

• added the required property 'status' to the response with the '200' status

• added the required property 'statusSetAt' to the response with the '200' status

For details, refer to the GET/v2/mysql-users/{mysqlUserId}/ endpoint.

Client package releases

mittwald PHP SDK Release v2.1.86

The latest release of the mittwald PHP SDK, version v2.1.86, introduces several new features and improvements:

Features

• Database User Status Enum: A new enum DatabaseUserStatus has been introduced to represent various states of a database user, including pending, ready, error, terminating, and disabled.
• MySQL User Enhancements: The MySqlUser class now includes a status field and a statusSetAt timestamp, enabling tracking of the current operational status of a MySQL user.

Improvements

• The ListArticlesRequest class has been refactored to remove the default limit value, making the limit a nullable field. A new method withoutLimit has been added to facilitate requests without a limit.

Deprecations

• The title field and its corresponding methods in the Profile class have been marked as deprecated and should not be used in future developments.

For more details, visit the release page.

mittwald JavaScript SDK Release 4.80.0

The mittwald JavaScript SDK has been updated to version 4.80.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.