Breaking (!) API changes for v2 API, August 8 to August 15

This week's update to the mittwald API includes changes to response property types, the addition of required request properties, and the introduction of new optional parameters across various endpoints, enhancing the overall functionality and data handling of the API.

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 response property type for '/items/supportInformation/email' in the GET operation for listing contributors has changed from 'string' to 'string' with format 'email'. This change more accurately represents how the API behaves. It could be a breaking change at compile time, depending on the client you are using.
• The response property type for '/anyOf[#/components/schemas/de.mittwald.v1.marketplace.Contributor]/supportInformation/email' in the GET operation for getting a contributor has changed from 'string' to 'string' with format 'email'. This change more accurately represents how the API behaves. It could be a breaking change at compile time, depending on the client you are using.
• The response property type for '/anyOf[#/components/schemas/de.mittwald.v1.marketplace.OwnContributor]/supportInformation/email' in the GET operation for getting a contributor has changed from 'string' to 'string' with format 'email'. This change more accurately represents how the API behaves. It could be a breaking change at compile time, depending on the client you are using.
• The request property 'support/email' has become required in the POST operation for registering an extension. This change more accurately represents how the API behaves. It could be a breaking change at compile time, depending on the client you are using.
• The request property type for 'support/email' in the POST operation for registering an extension has changed from 'string' to 'string' with format 'email'. This change more accurately represents how the API behaves. It could be a breaking change at compile time, depending on the client you are using.
• The request property 'support/email' has become required in the PATCH operation for patching an extension. This change more accurately represents how the API behaves. It could be a breaking change at compile time, depending on the client you are using.
• The request property type for 'support/email' in the PATCH operation for patching an extension has changed from 'string' to 'string' with format 'email'. This change more accurately represents how the API behaves. It could be a breaking change at compile time, depending on the client you are using.
• The response property '/items/supportInformation/email' has become required for the status '200' in the GET operation for listing contributors.
• The response property '/anyOf[#/components/schemas/de.mittwald.v1.marketplace.Contributor]/supportInformation/email' has become required for the status '200' in the GET operation for getting a contributor.
• The response property '/anyOf[#/components/schemas/de.mittwald.v1.marketplace.OwnContributor]/supportInformation/email' has become required for the status '200' in the GET operation for getting a contributor.
• The response property '/items/support' has been updated in the GET operation for listing own extensions to include the required property inherited, describing if the support information are deviating from the support information of the contributor.
• The response property 'support' has been updated in the GET operation for getting own extension to include the required property inherited, describing if the support information are deviating from the support information of the contributor.
• The response property 'support' has been updated in the PATCH operation for patching an extension to include the required property inherited, describing if the support information are deviating from the support information of the contributor.
• The optional property '/oneOf[#/components/schemas/de.mittwald.v1.extension.SubscriptionBasedContract]/currentPrice' has been added to the response with status '200' in the POST operation for previewing an order.
• The response property '/items/support' has been updated in the GET operation for listing extensions to include the required property inherited, describing if the support information are deviating from the support information of the contributor.
• The response property '/anyOf[#/components/schemas/de.mittwald.v1.marketplace.Extension]/support' has been updated in the GET operation for getting an extension to include the required property inherited, describing if the support information are deviating from the support information of the contributor.
• The response property '/anyOf[#/components/schemas/de.mittwald.v1.marketplace.UnpublishedExtension]/support' has been updated in the GET operation for getting an extension to include the required property inherited, describing if the support information are deviating from the support information of the contributor.
• The success response status code has been changed from '204' to '200' for the POST operation for setting a record set on a DNSZone to managed.
• The request property type for 'quotaInBytes' has changed from 'number' to 'integer' in the PATCH operation for updating the quota of a MailAddress.
• The request property type for 'quotaInBytes' has changed from 'number' to 'integer' in the PUT operation for updating the quota of a MailAddress.
• The request property type for 'mailbox/quotaInBytes' has changed from 'number' to 'integer' in the POST operation for creating a MailAddress.
• The default value '1.00' has been replaced with the minimum value for the 'query' request parameter 'page' in the GET operation for listing servers.
• The minimum value for the 'query' request parameter 'limit' has been increased from '0.00' to '1.00' in the GET operation for listing servers.
• The new enum value 'anchorIcon' has been added to the 'path' request parameter 'fileUploadType' in the GET operation for getting a FileUploadType's rules.
• The new optional request property 'orderData/oneOf[#/components/schemas/de.mittwald.v1.order.ProjectHostingOrderPreview]/promotionCode' has been added in the POST operation for previewing an order.
• The new optional request property 'orderData/oneOf[#/components/schemas/de.mittwald.v1.order.ServerOrderPreview]/promotionCode' has been added in the POST operation for previewing an order.
• The optional property '/anyOf[#/components/schemas/de.mittwald.v1.order.HostingOrderPreviewResponse]/possibleFreeTrialDays' has been added to the response with status '200' in the POST operation for previewing an order.
• The new optional 'query' request parameter 'order' has been added in the GET operation for listing projects.
• The new optional 'query' request parameter 'sort' has been added in the GET operation for listing projects.
• The new optional 'query' request parameter 'order' has been added in the GET operation for listing servers.
• The new optional 'query' request parameter 'sort' has been added in the GET operation for listing servers.

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

Detailed changes

Changes in "List contributors"

• ⚠️ Breaking: the '/items/supportInformation/email' response's property type/format changed from 'string'/'' to 'string'/'email' for status '200'. This change more accurately represents how the API behaves. It could be a breaking change at compile time, depending on the client you are using.

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

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

Changes in "Get a contributor"

• ⚠️ Breaking: the '/anyOf[#/components/schemas/de.mittwald.v1.marketplace.Contributor]/supportInformation/email' response's property type/format changed from 'string'/'' to 'string'/'email' for status '200'. This change more accurately represents how the API behaves. It could be a breaking change at compile time, depending on the client you are using.

• ⚠️ Breaking: the '/anyOf[#/components/schemas/de.mittwald.v1.marketplace.OwnContributor]/supportInformation/email' response's property type/format changed from 'string'/'' to 'string'/'email' for status '200'. This change more accurately represents how the API behaves. It could be a breaking change at compile time, depending on the client you are using.

• the response property '/anyOf[#/components/schemas/de.mittwald.v1.marketplace.Contributor]/supportInformation/email' became required for the status '200'

• the response property '/anyOf[#/components/schemas/de.mittwald.v1.marketplace.OwnContributor]/supportInformation/email' became required for the status '200'

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

Changes in "List Extensions of own contributor"

• added the required property inherited to the '/items/support' property for the response status '200', describing if the support information are deviating from the support information of the contributor.

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

Changes in "Register an Extension"

• ⚠️ Breaking: the request property 'support/email' became required. This change more accurately represents how the API behaves.

• ⚠️ Breaking: the 'support/email' request property type/format changed from 'string'/'' to 'string'/'email'. This change more accurately represents how the API behaves. It could be a breaking change at compile time, depending on the client you are using.

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

Changes in "Get Extension of own contributor"

• added the required property inherited to the 'support' property for the response status '200', describing if the support information are deviating from the support information of the contributor.

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

Changes in "Patch Extension"

• ⚠️ Breaking: the request property 'support/email' became required. This change more accurately represents how the API behaves.

• ⚠️ Breaking: the 'support/email' request property type/format changed from 'string'/'' to 'string'/'email'. This change more accurately represents how the API behaves. It could be a breaking change at compile time, depending on the client you are using.

• added the required property inherited to the 'support' property for the response status '200', describing if the support information are deviating from the support information of the contributor.

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

Changes in "Set a record set on a DNS Zone to managed"

• changed the success response from '204' to '200', since 'content' is and has always been returned

For details, refer to the POST/v2/dns-zones/{dnsZoneId}/record-sets/{recordSet}/actions/set-managed/ endpoint.

Changes in "List Extensions"

• added the required property inherited to the '/items/support' property for the response status '200', describing if the support information are deviating from the support information of the contributor.

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

Changes in "Get an Extension"

• added the required property inherited to the 'support' property for the response status '200', describing if the support information are deviating from the support information of the contributor.

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

Changes in "Update the quota of a mail address"

• the 'quotaInBytes' request property type/format changed from 'number'/'int64' to 'integer'/'int64'

For details, refer to the PATCH/v2/mail-addresses/{mailAddressId}/quota/ endpoint.

Changes in "Update the quota of a mail address"

• the 'quotaInBytes' request property type/format changed from 'number'/'int64' to 'integer'/'int64'

For details, refer to the PUT/v2/mail-addresses/{mailAddressId}/quota/ endpoint.

Changes in "Create a mail address"

• the '/oneOf[#/components/schemas/de.mittwald.v1.mail.CreateMailAddress]/mailbox/quotaInBytes' request property type/format changed from 'number'/'int64' to 'integer'/'int64'

For details, refer to the POST/v2/projects/{projectId}/mail-addresses/ endpoint.

Changes in "List Servers belonging to the executing user"

• changes: for the 'query' request parameter 'page', default value '1.00' was replaced with min, the min was increased from '0.00' to '1.00'

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

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

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

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

Changes in "Get the Contract Strategy of an Extension Instance"

• added the optional property '/oneOf[#/components/schemas/de.mittwald.v1.extension.SubscriptionBasedContract]/currentPrice' to the response with the '200' status

For details, refer to the GET/v2/extension-instances/{extensionInstanceId}/contract/ endpoint.

Changes in "Get a FileUploadType's rules"

• added the new enum value 'anchorIcon' to the 'path' request parameter 'fileUploadType'

For details, refer to the GET/v2/file-upload-types/{fileUploadType}/rules/ endpoint.

Changes in "Preview Order"

• added the new optional request property 'orderData/oneOf[#/components/schemas/de.mittwald.v1.order.ProjectHostingOrderPreview]/promotionCode'

• added the new optional request property 'orderData/oneOf[#/components/schemas/de.mittwald.v1.order.ServerOrderPreview]/promotionCode'

• added the optional property '/anyOf[#/components/schemas/de.mittwald.v1.order.HostingOrderPreviewResponse]/possibleFreeTrialDays' to the response with the '200' status

For details, refer to the POST/v2/order-previews/ endpoint.

Changes in "List Projects belonging to the executing user"

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

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

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

Client package releases

mittwald JavaScript SDK Release 4.201.0

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

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

The mittwald JavaScript SDK version 4.199.1 has been released on August 14, 2025. This update includes several bug fixes:

• The SDK now correctly respects nullable properties in schemas, improving data handling and validation.
• Minor typographical errors have been corrected to enhance code clarity and maintainability.

For more details, you can view the release on GitHub: mittwald JavaScript SDK 4.199.1.

mittwald JavaScript SDK Release 4.199.0

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

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