Breaking (!) API changes for v2 API, March 14 to March 21

This week, the mittwald API introduces several enhancements, including default values for the 'limit' and 'skip' parameters in the cronjob listing endpoint, new optional request properties and parameters for extension and backup management, and the addition of required properties in responses for extensions and customers.

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

• For the GET operation cronjob-list-cronjobs at the path /v2/projects/{projectId}/cronjobs, the following changes have been made:

  • A default value of 1000.00 was added for the query request parameter limit.
  • A default value of 0.00 was added for the query request parameter skip.
  • The minimum value for the query request parameter limit was increased from 0.00 to 1.00. This is a breaking change.
  • The minimum value for the query request parameter page was increased from 0.00 to 1.00. This is a breaking change.

• The following endpoints have been added:

  • POST operation extension-request-asset-upload at the path /v2/contributors/{contributorId}/extensions/{extensionId}/assets.
  • DELETE operation extension-remove-asset at the path /v2/contributors/{contributorId}/extensions/{extensionId}/assets/{assetRefId}.
  • POST operation extension-request-logo-upload at the path /v2/contributors/{contributorId}/extensions/{extensionId}/logo.
  • PUT operation extension-set-extension-published-state at the path /v2/contributors/{contributorId}/extensions/{extensionId}/published.
  • POST operation extension-request-extension-verification at the path /v2/contributors/{contributorId}/extensions/{extensionId}/verification-process.

• For the GET operation customer-list-customers at the path /v2/customers, the following optional properties have been added to the response with the 200 status:

  • /items/flags
  • /items/levelOfUndeliverableDunningNotice

• For the GET operation customer-get-customer at the path /v2/customers/{customerId}, the following optional properties have been added to the response with the 200 status:

  • flags
  • levelOfUndeliverableDunningNotice

• The response property /items/logoRefId for the GET operation extension-list-extensions at the path /v2/extensions has become required for the 200 status.

• The response property logoRefId for the GET operation extension-get-extension at the path /v2/extensions/{extensionId} has become required for the 200 status.

• For the GET operation backup-list-project-backups at the path /v2/projects/{projectId}/backups, the following new optional query request parameters have been added:

  • limit
  • page
  • searchTerm
  • skip

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

Detailed changes

Changes in "List cronjobs belonging to a Project"

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

• ⚠️ Breaking: for the 'query' request parameter 'skip', default value '0.00' was added

• ⚠️ Breaking: for the 'query' request parameter 'limit', the min was increased from '0.00' to '1.00'

• ⚠️ Breaking: for the 'query' request parameter 'page', the min was increased from '0.00' to '1.00'

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

Changes in "Register an Extension"

• added the new optional request property 'externalFrontends'

For details, refer to the POST/v2/contributors/{contributorId}/extensions/ endpoint.

Changes in "Add an asset to an extension"

• endpoint added

For details, refer to the POST/v2/contributors/{contributorId}/extensions/{extensionId}/assets/ endpoint.

Changes in "Remove an asset of an extension"

• endpoint added

For details, refer to the DELETE/v2/contributors/{contributorId}/extensions/{extensionId}/assets/{assetRefId}/ endpoint.

Changes in "Add a logo to an extension"

• endpoint added

For details, refer to the POST/v2/contributors/{contributorId}/extensions/{extensionId}/logo/ endpoint.

Changes in "Publish or withdraw an Extension"

• endpoint added

For details, refer to the PUT/v2/contributors/{contributorId}/extensions/{extensionId}/published/ endpoint.

Changes in "Start the verification process of an Extension"

• endpoint added

For details, refer to the POST/v2/contributors/{contributorId}/extensions/{extensionId}/verification-process/ endpoint.

Changes in "Get all customer profiles the authenticated user has access to"

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

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

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

Changes in "Get a customer profile"

• added the optional property 'flags' to the response with the '200' status

• added the optional property 'levelOfUndeliverableDunningNotice' to the response with the '200' status

For details, refer to the GET/v2/customers/{customerId}/ endpoint.

Changes in "List Extensions"

• the response property '/items/logoRefId' became required for the status '200'

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

Changes in "Get an Extension"

• the response property 'logoRefId' became required for the status '200'

For details, refer to the GET/v2/extensions/{extensionId}/ endpoint.

Changes in "List Backups belonging to a Project"

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

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

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

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

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

Client package releases

mittwald PHP SDK Release v2.1.121

The mittwald PHP SDK has released version v2.1.121 with several new features, breaking changes, and improvements.

Added Features

• ListProjectBackupsRequest Enhancements:
  • Introduced a searchTerm parameter for filtering backups.
  • Added limit, skip, and page parameters to support pagination.
• Customer Schema Updates:
  • CreateCustomer and UpdateCustomer responses now limit the name field to 80 characters.
  • New schema elements in the Customer class, including flags and levelOfUndeliverableDunningNotice.

Breaking Changes

• The Customer class now includes additional properties (flags and levelOfUndeliverableDunningNotice), which may affect customer creation and updates.

Bug Fixes and Improvements

• Enhanced validation logic for new properties in ListProjectBackupsRequest.
• Improved backward compatibility while integrating new features.

For more details, visit the release page.

mittwald PHP SDK Release v2.1.120

The mittwald PHP SDK has been updated to version 2.1.120. This release introduces several new features and deprecations aimed at improving asset management for extensions.

Added Features

• Asset Removal: A new method, extensionRemoveAsset, has been added to the MarketplaceClient to support the removal of assets from extensions.
• Asset Upload Request: The extensionRequestAssetUpload method allows users to request the upload of assets associated with an extension.
• Logo Upload Request: The extensionRequestLogoUpload method provides functionality to request logo uploads for extensions, enhancing asset management capabilities.

Deprecated

• The externalFrontend field in ExtensionRegisterExtensionRequest and ExtensionRegisterExtensionRequestBody is now deprecated. Users are encouraged to use externalFrontends instead.

For more details, visit the release page.

mittwald PHP SDK Release v2.1.119

The mittwald PHP SDK has been updated to version v2.1.119. This release introduces several enhancements and changes to improve functionality and usability.

Features Added

• Default Values for Pagination: The ListCronjobsRequest class now includes default values for the limit and skip properties, set to 1000 and 0, respectively.
• Input Validation: Updated constraints ensure that the limit and page properties must be at least 1.

Changes

• The limit property is no longer nullable and now defaults to an integer with a minimum value of 1.
• The skip property is also no longer nullable and defaults to an integer initialized to 0.
• The getLimit and getSkip methods have been updated to return non-nullable integers.
• The withoutLimit and withoutSkip methods have been removed to eliminate unnecessary nullable handling.
• Serialization logic in toArray has been simplified to always include limit and skip without nullable checks.

For more details, visit the release page.

Release Summary: mittwald PHP SDK v2.1.118

The mittwald PHP SDK has released version 2.1.118, introducing significant enhancements in handling extension verification and managing the published state of extensions within the Marketplace API.

Key features include:

• Extension Verification: New classes have been added to facilitate requests and manage responses related to the verification process of extensions.
• Published State Management: Methods have been introduced to update the visibility (published state) of extensions, addressing edge cases such as user limits and not found conditions.

New Additions:

• Extension Verification Handling:

  • Classes for managing various response scenarios during the extension verification process, including bad requests, default responses, and too many requests scenarios.

• Extension Published State Management:

  • Classes for handling responses when setting the published state of extensions, including successful, not found, and too many requests scenarios.

Updates:

• MarketplaceClient and MarketplaceClientImpl:

  • New methods added to initiate extension verification and manage published states, with implementations to handle corresponding requests and responses.

• Extension Asset:

  • Documentation updates for the index property in ExtensionAsset.php to clarify its role in asset ordering.

For more details, visit the release page.

mittwald JavaScript SDK Release 4.122.0

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

mittwald JavaScript SDK Release 4.121.0

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

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

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