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

This week's update to the mittwald API includes increased maximum lengths for various FQDN properties, added optional pricing details to several responses, and the introduction of new non-success response statuses for specific 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 maximum length of the response property recordSet/mx/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordMXCustom]/records/items/fqdn was increased from 50 to 255 for the 200 response status in the GET /v2/dns-zones/{dnsZoneId} and GET /v2/projects/{projectId}/dns-zones operations. This is a breaking change.
• The maximum length of the response property recordSet/srv/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordSRVComponent]/records/items/fqdn was increased from 50 to 255 for the 200 response status in the GET /v2/dns-zones/{dnsZoneId} and GET /v2/projects/{projectId}/dns-zones operations. This is a breaking change.
• The minimum length of the request property /oneOf[#/components/schemas/de.mittwald.v1.dns.RecordCNAMEComponent]/fqdn was increased from 0 to 1 in the PUT /v2/dns-zones/{dnsZoneId}/record-sets/{recordSet} and PUT /v2/dns/zones/{zoneId}/recordset/cname operations. This is a breaking change.
• The maximum length of the request property /oneOf[#/components/schemas/de.mittwald.v1.dns.RecordCNAMEComponent]/fqdn was set to 255 in the PUT /v2/dns-zones/{dnsZoneId}/record-sets/{recordSet} and PUT /v2/dns/zones/{zoneId}/recordset/cname operations.
• The optional property /items/pricingDetails was added to the response with the 200 status in the GET /v2/contributors/{contributorId}/extensions and GET /v2/extensions operations.
• The optional property pricingDetails was added to the response with the 200 status in the GET /v2/contributors/{contributorId}/extensions/{extensionId} and PATCH /v2/contributors/{contributorId}/extensions/{extensionId} operations.
• The optional property /items/deletionProhibitedBy was added to the response with the 200 status in the GET /v2/customers operation.
• The optional property deletionProhibitedBy was added to the response with the 200 status in the GET /v2/customers/{customerId} operation.
• A non-success response with the status 400 was added in the GET /v2/customers/{customerId}/leads and GET /v2/customers/{customerId}/unlocked-leads operations.
• A non-success response with the status 409 was added in the POST /v2/ingresses operation.
• A non-success response with the status 404 was removed from the DELETE /v2/extension-instances/{extensionInstanceId} operation.

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/mx/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordMXCustom]/records/items/fqdn' response property's maxLength was increased from '50' to '255' for the response status '200'

• ⚠️ Breaking: the 'recordSet/srv/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordSRVComponent]/records/items/fqdn' response property's maxLength was increased from '50' to '255' for the response status '200'

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

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

• ⚠️ Breaking: the '/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordCNAMEComponent]/fqdn' request property's minLength was increased from '0' to '1'

• the '/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordCNAMEComponent]/fqdn' request property's maxLength was set to '255'

• the '/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordMXCustom]/records/items/fqdn' request property's maxLength was increased from '50' to '255'

• the '/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordSRVComponent]/records/items/fqdn' request property's maxLength was increased from '50' to '255'

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

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

• ⚠️ Breaking: the '/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordCNAMEComponent]/fqdn' request property's minLength was increased from '0' to '1'

• the '/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordCNAMEComponent]/fqdn' request property's maxLength was set to '255'

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

Changes in "List DNS Zones belonging to a Project"

• ⚠️ Breaking: the '/items/recordSet/mx/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordMXCustom]/records/items/fqdn' response property's maxLength was increased from '50' to '255' for the response status '200'

• ⚠️ Breaking: the '/items/recordSet/srv/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordSRVComponent]/records/items/fqdn' response property's maxLength was increased from '50' to '255' for the response status '200'

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

Changes in "List Extensions of own contributor"

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

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

Changes in "Get Extension of own contributor"

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

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

Changes in "Patch Extension"

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

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

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

• added the optional property '/items/deletionProhibitedBy' 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 'deletionProhibitedBy' to the response with the '200' status

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

Changes in "Get all leads. Use the unlocked routes for more lead details"

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

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

Changes in "Get all unlocked leads. Organisation can unlock leads"

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

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

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

• the '/oneOf[#/components/schemas/de.mittwald.v1.dns.RecordMXCustom]/records/items/fqdn' request property's maxLength was increased from '50' to '255'

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]/records/items/fqdn' request property's maxLength was increased from '50' to '255'

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

Changes in "Delete a free extension instance. If the Extension is chargable the contract must be terminated instead"

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

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

Changes in "List Extensions"

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

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

Changes in "Get an Extension"

• added the optional property '/anyOf[#/components/schemas/de.mittwald.v1.marketplace.Extension]/pricingDetails' to the response with the '200' status

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

Changes in "Create an Ingress"

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

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

Client package releases

mittwald JavaScript SDK Release 4.263.0

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

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

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

mittwald JavaScript SDK Release 4.260.0

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