Breaking (!) API changes for v2 API, February 20 to February 27

This week's changelog for the mittwald API includes several updates, such as the reduction of minimum TTL values for various DNS record types, the addition of new endpoints for license management, and enhancements to request and response properties across multiple operations.

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 minimum value for the response property recordSet/caa/settings/ttl/seconds was decreased from 300.00 to 60.00 for the response status 200 in the GET /v2/dns-zones/{dnsZoneId} and GET /v2/projects/{projectId}/dns-zones operations. This is a breaking change.
• The minimum value for the response property recordSet/cname/settings/ttl/seconds was decreased from 300.00 to 60.00 for the response status 200 in the GET /v2/dns-zones/{dnsZoneId} and GET /v2/projects/{projectId}/dns-zones operations. This is a breaking change.
• The minimum value for the response property recordSet/combinedARecords/settings/ttl/seconds was decreased from 300.00 to 60.00 for the response status 200 in the GET /v2/dns-zones/{dnsZoneId} and GET /v2/projects/{projectId}/dns-zones operations. This is a breaking change.
• The minimum value for the response property recordSet/mx/settings/ttl/seconds was decreased from 300.00 to 60.00 for the response status 200 in the GET /v2/dns-zones/{dnsZoneId} and GET /v2/projects/{projectId}/dns-zones operations. This is a breaking change.
• The minimum value for the response property recordSet/srv/settings/ttl/seconds was decreased from 300.00 to 60.00 for the response status 200 in the GET /v2/dns-zones/{dnsZoneId} and GET /v2/projects/{projectId}/dns-zones operations. This is a breaking change.
• The minimum value for the response property recordSet/txt/settings/ttl/seconds was decreased from 300.00 to 60.00 for the response status 200 in the GET /v2/dns-zones/{dnsZoneId} and GET /v2/projects/{projectId}/dns-zones operations. This is a breaking change.
• The request property database/projectId was removed from the POST /v2/projects/{projectId}/mysql-databases operation.
• Non-success responses with status 400, 412, and 409 were added to the POST /v2/app-installations/{appInstallationId}/actions/{action} and POST /v2/dns-zones operations.
• A new optional request parameter versionRange was added to the GET /v2/apps/{appId}/versions operation.
• A new optional request property avoidEmailConfirmation was added to the PATCH /v2/domains/{domainId}/contacts/{contact} operation.
• Several new endpoints were added, including:
  • GET /v2/licenses/{licenseId} for retrieving a license.
  • POST /v2/licenses/{licenseId}/actions/rotate-key for rotating a license key.
  • GET /v2/licenses/{licenseId}/contract for retrieving the contract for a given license.
  • POST /v2/projects/{projectId}/actions/validate-license-key for validating a license key for a project.
  • GET /v2/projects/{projectId}/licenses for listing licenses belonging to a project.
• The optional property /items/updateSchedule was added to the response with status 200 for the GET /v2/projects/{projectId}/stacks}, GET /v2/stacks/{stackId}, PATCH /v2/stacks/{stackId}, and PUT /v2/stacks/{stackId} operations.
• The request property orderType received a new enum value license in the POST /v2/order-previews and POST /v2/orders operations.
• The request property orderData received new oneOf entries in the POST /v2/order-previews and POST /v2/orders operations.
• The response body for the POST /v2/order-previews operation now includes #/components/schemas/de.mittwald.v1.order.LicenseOrderPreviewResponse in the anyOf list for the response status 200.
• The request property minimum value for settings/ttl/seconds was decreased from 300.00 to 60.00 for various record types in the PUT /v2/dns-zones/{dnsZoneId}/record-sets/{recordSet} and deprecated operations.

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

Detailed changes

Changes in "Get a DNS Zone"

• ⚠️ Breaking: the 'recordSet/caa/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordCAAComponent]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' response property's min was decreased from '300.00' to '60.00' for the response status '200'

• ⚠️ Breaking: the 'recordSet/cname/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordCNAMEComponent]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' response property's min was decreased from '300.00' to '60.00' for the response status '200'

• ⚠️ Breaking: the 'recordSet/combinedARecords/oneOf[#/components/schemas/de.mittwald.v1.dns.CombinedACustom]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' response property's min was decreased from '300.00' to '60.00' for the response status '200'

• ⚠️ Breaking: the 'recordSet/mx/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordMXCustom]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' response property's min was decreased from '300.00' to '60.00' for the response status '200'

• ⚠️ Breaking: the 'recordSet/srv/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordSRVComponent]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' response property's min was decreased from '300.00' to '60.00' for the response status '200'

• ⚠️ Breaking: the 'recordSet/txt/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordTXTComponent]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' response property's min was decreased from '300.00' to '60.00' for the response status '200'

For details, refer to the GET/v2/dns-zones/{dnsZoneId}/ endpoint.

Changes in "List DNS Zones belonging to a Project"

• ⚠️ Breaking: the '/items/recordSet/caa/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordCAAComponent]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' response property's min was decreased from '300.00' to '60.00' for the response status '200'

• ⚠️ Breaking: the '/items/recordSet/cname/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordCNAMEComponent]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' response property's min was decreased from '300.00' to '60.00' for the response status '200'

• ⚠️ Breaking: the '/items/recordSet/combinedARecords/oneOf[#/components/schemas/de.mittwald.v1.dns.CombinedACustom]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' response property's min was decreased from '300.00' to '60.00' for the response status '200'

• ⚠️ Breaking: the '/items/recordSet/mx/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordMXCustom]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' response property's min was decreased from '300.00' to '60.00' for the response status '200'

• ⚠️ Breaking: the '/items/recordSet/srv/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordSRVComponent]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' response property's min was decreased from '300.00' to '60.00' for the response status '200'

• ⚠️ Breaking: the '/items/recordSet/txt/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordTXTComponent]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' response property's min was decreased from '300.00' to '60.00' for the response status '200'

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

Changes in "Create a MySQL database with a MySQL user"

• removed the request property 'database/projectId'

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

Changes in "Trigger a runtime action belonging to an app installation"

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

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

For details, refer to the POST/v2/app-installations/{appInstallationId}/actions/{action}/ endpoint.

Changes in "List app versions belonging to an app"

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

For details, refer to the GET/v2/apps/{appId}/versions/ endpoint.

Changes in "Create a DNS Zone"

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

For details, refer to the POST/v2/dns-zones/ endpoint.

Changes in "Update a record set on a DNS Zone"

• the '/oneOf[#/components/schemas/de.mittwald.v1.dns.CombinedACustom]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' request property's min was decreased from '300.00' to '60.00'

• the '/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordCAAComponent]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' request property's min was decreased from '300.00' to '60.00'

• the '/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordCNAMEComponent]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' request property's min was decreased from '300.00' to '60.00'

• the '/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordMXCustom]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' request property's min was decreased from '300.00' to '60.00'

• the '/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordSRVComponent]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' request property's min was decreased from '300.00' to '60.00'

• the '/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordTXTComponent]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' request property's min was decreased from '300.00' to '60.00'

For details, refer to the PUT/v2/dns-zones/{dnsZoneId}/record-sets/{recordSet}/ endpoint.

Changes in "updates a-records for a specific zone"

• the '/oneOf[#/components/schemas/de.mittwald.v1.dns.CombinedACustom]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' request property's min was decreased from '300.00' to '60.00'

For details, refer to the PUT/v2/dns/zones/{zoneId}/recordset/acombined/custom/ endpoint.

Changes in "updates cname-record for a specific zone"

• the '/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordCNAMEComponent]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' request property's min was decreased from '300.00' to '60.00'

For details, refer to the PUT/v2/dns/zones/{zoneId}/recordset/cname/ endpoint.

Changes in "updates mx-records for a specific zone"

• the '/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordMXCustom]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' request property's min was decreased from '300.00' to '60.00'

For details, refer to the PUT/v2/dns/zones/{zoneId}/recordset/mx/custom/ endpoint.

Changes in "updates srv-records for a specific zone"

• the '/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordSRVComponent]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' request property's min was decreased from '300.00' to '60.00'

For details, refer to the PUT/v2/dns/zones/{zoneId}/recordset/srv/ endpoint.

Changes in "updates txt-records for a specific zone"

• the '/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordTXTComponent]/settings/ttl/oneOf[#/components/schemas/de.mittwald.v1.dns.TtlSeconds]/seconds' request property's min was decreased from '300.00' to '60.00'

For details, refer to the PUT/v2/dns/zones/{zoneId}/recordset/txt/ endpoint.

Changes in "Update a contact of a Domain"

• added the new optional request property 'avoidEmailConfirmation'

For details, refer to the PATCH/v2/domains/{domainId}/contacts/{contact}/ endpoint.

Changes in "Get a license"

• endpoint added

For details, refer to the GET/v2/licenses/{licenseId}/ endpoint.

Changes in "rotate a License's key, i.e. revoke the old and generate a new one"

• endpoint added

For details, refer to the POST/v2/licenses/{licenseId}/actions/rotate-key/ endpoint.

Changes in "Return the Contract for the given License"

• endpoint added

For details, refer to the GET/v2/licenses/{licenseId}/contract/ endpoint.

Changes in "Preview Order"

• added the new 'license' enum value to the request property 'orderType'

• added '#/components/schemas/de.mittwald.v1.order.LicenseOrderPreview' to the 'orderData' request property 'oneOf' list

• added '#/components/schemas/de.mittwald.v1.order.LicenseOrderPreviewResponse' to the response body 'anyOf' list for the response status '200'

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

Changes in "Create an Order"

• added the new 'license' enum value to the request property 'orderType'

• added '#/components/schemas/de.mittwald.v1.order.LicenseOrder' to the 'orderData' request property 'oneOf' list

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

Changes in "Validate a License's key for a project"

• endpoint added

For details, refer to the POST/v2/projects/{projectId}/actions/validate-license-key/ endpoint.

Changes in "List Licenses belonging to a Project"

• endpoint added

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

Changes in "List Stacks belonging to a Project"

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

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

Changes in "Get a Stack"

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

For details, refer to the GET/v2/stacks/{stackId}/ endpoint.

Changes in "Create, update or delete Services or Volumes belonging to a Stack"

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

For details, refer to the PATCH/v2/stacks/{stackId}/ endpoint.

Changes in "Declaratively create, update or delete Services or Volumes belonging to a Stack"

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

For details, refer to the PUT/v2/stacks/{stackId}/ endpoint.

Changes in "Set an update schedule for a Stack"

• endpoint added

For details, refer to the PUT/v2/stacks/{stackId}/update-schedule/ endpoint.

Client package releases

mittwald PHP SDK Release v2.1.192

The latest release of the mittwald PHP SDK, version 2.1.192, introduces several new features and improvements. A key addition is the new API endpoint for setting an update schedule for a stack, allowing users to define cron-based schedules for updates. This release also includes enhanced descriptions in API request and response schemas, providing better clarity on command, entrypoint, environment variables, and resource specifications such as CPU and memory limits.

Documentation has been improved to offer clearer guidance on expected formats and examples, aiding developers in API integration. New methods, such as setStackUpdateSchedule, have been added to the ContainerClient interface, and various response classes have been created for error handling in this method.

Schema updates include detailed descriptions for resource specifications and new fields in the StackResponse schema to support scheduling updates. Additionally, consistency improvements have been made in request schemas for better semantic understanding.

For more details, visit the release page.

mittwald PHP SDK v2.1.191 Release Summary

The latest release of the mittwald PHP SDK, version v2.1.191, introduces a comprehensive License API, enhancing the SDK's capabilities in license management. This update includes:

• LicenseClient Implementation: New functionalities for managing licenses, such as fetching a single license, listing licenses for a project, rotating license keys, and validating license keys for a project.

• Response Classes: Introduction of various response classes for operations like GetLicense, ListLicensesForProject, and RotateLicenseKey, providing detailed response handling for different scenarios.

• Data Models: Addition of data models for licenses, keys, and related entities, along with enums and request/response classes to support these operations.

• Enhancements: New schema definitions for input validation and response handling, along with improved functionality for processing license keys.

• License Order Support: Integration for managing TYPO3 ELTS license orders, including key management and version handling.

This release significantly enhances the SDK's ability to manage licenses effectively, ensuring robust API interactions for various license-related operations.

For more details, visit the release page.

mittwald PHP SDK Release v2.1.190

The latest release of the mittwald PHP SDK, version 2.1.190, introduces several significant updates.

Breaking Changes

• The deprecated method deprecatedCronjobAbortExecution has been removed from the CronjobClient interface, along with its related classes and functionality.

Features

• A new boolean property avoidEmailConfirmation has been added to the UpdateDomainContactRequest and UpdateDomainContactRequestBody classes. This property allows users to bypass email confirmation during updates, which may lead to a 60-day transfer lock on the domain.

Improvements

• Enhancements have been made to the UpdateDomainContactRequestBody class, including methods to set and unset the avoidEmailConfirmation parameter, with added validation during input processing.

No specific bug fixes were mentioned in this release.

For more details, visit the release page.

mittwald JavaScript SDK Release 4.311.0

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

mittwald JavaScript SDK Release 4.310.1

The mittwald JavaScript SDK version 4.310.1 has been released. This update primarily addresses a bug fix related to compatibility with Axios versions greater than 1.13.2. For more details on the changes, you can view the release notes.

mittwald JavaScript SDK Release 4.310.0

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

mittwald JavaScript SDK Release 4.309.0

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

mittwald JavaScript SDK Release 4.308.0

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

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

mittwald JavaScript SDK Release 4.306.0

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