Breaking (!) API changes for v2 API, August 21 to August 28

This week's update to the mittwald API includes the removal of the 'application/json' media type for '204' responses in several endpoints, the addition of new optional and required properties across various responses, and the introduction of new endpoints for managing app installations and extensions.

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 media type application/json has been removed for the response with status 204 for the following operations:

  • DELETE operation extension-delete-extension-instance at the path /v2/extension-instances/{extensionInstanceId}.
  • POST operation extension-disable-extension-instance at the path /v2/extension-instances/{extensionInstanceId}/actions/disable.
  • POST operation extension-enable-extension-instance at the path /v2/extension-instances/{extensionInstanceId}/actions/enable. This is a breaking change.

• The new enum value hasOrdersInProgress has been added to the /items/deletionProhibitedBy/items/ response property for the response status 200 for the following operations:

  • GET operation customer-list-customers at the path /v2/customers.
  • GET operation customer-get-customer at the path /v2/customers/{customerId}.

• The optional property /items/sourceAppInstallationId has been added to the response with status 200 for the GET operation app-list-appinstallations-for-user at the path /v2/app-installations.

• The optional property /items/staging has been added to the response with status 200 for the GET operation app-list-appinstallations-for-user at the path /v2/app-installations.

• The optional property sourceAppInstallationId has been added to the response with status 200 for the GET operation app-get-appinstallation at the path /v2/app-installations/{appInstallationId}.

• The optional property staging has been added to the response with status 200 for the GET operation app-get-appinstallation at the path /v2/app-installations/{appInstallationId}.

• The following endpoints have been added:

  • POST operation app-detach-appinstallation-staging at the path /v2/app-installations/{appInstallationId}/actions/detach-staging.
  • POST operation app-promote-appinstallation-staging at the path /v2/app-installations/{appInstallationId}/actions/promote-staging.
  • POST operation app-request-appinstallation-staging at the path /v2/app-installations/{appInstallationId}/actions/staging.

• The optional property /items/createdAt has been added to the response with status 200 for the GET operation extension-list-own-extensions at the path /v2/contributors/{contributorId}/extensions.

• The optional property /items/publishedAt has been added to the response with status 200 for the GET operation extension-list-own-extensions at the path /v2/contributors/{contributorId}/extensions.

• The optional property createdAt has been added to the response with status 200 for the GET operation extension-get-own-extension at the path /v2/contributors/{contributorId}/extensions/{extensionId}.

• The optional property publishedAt has been added to the response with status 200 for the GET operation extension-get-own-extension at the path /v2/contributors/{contributorId}/extensions/{extensionId}.

• The optional property createdAt has been added to the response with status 200 for the PATCH operation extension-patch-extension at the path /v2/contributors/{contributorId}/extensions/{extensionId}.

• The optional property publishedAt has been added to the response with status 200 for the PATCH operation extension-patch-extension at the path /v2/contributors/{contributorId}/extensions/{extensionId}.

• The optional property /items/recipient/leitwegId has been added to the response with status 200 for the GET operation contributor-list-incoming-invoices at the path /v2/contributors/{contributorId}/invoices/incoming.

• The optional property /items/recipient/purchaseOrderReference has been added to the response with status 200 for the GET operation contributor-list-incoming-invoices at the path /v2/contributors/{contributorId}/invoices/incoming.

• The optional property /items/owner/purchaseOrderReference has been added to the response with status 200 for the GET operation customer-list-customers at the path /v2/customers.

• The new optional request property owner/purchaseOrderReference has been added for the following operations:

  • POST operation customer-create-customer at the path /v2/customers.
  • PUT operation customer-update-customer at the path /v2/customers/{customerId}.

• The optional property owner/purchaseOrderReference has been added to the response with status 200 for the GET operation customer-get-customer at the path /v2/customers/{customerId}.

• The required property parentCustomerId has been added to the response with status 200 for the following operations:

  • GET operation extension-get-extension-instance-for-customer at the path /v2/customers/{customerId}/extensions/{extensionId}.
  • GET operation extension-list-extension-instances at the path /v2/extension-instances.
  • GET operation extension-get-extension-instance at the path /v2/extension-instances/{extensionInstanceId}.

• The new optional request parameter parentCustomerId has been added for the GET operation extension-list-extension-instances at the path /v2/extension-instances.

• The required property /items/publishedAt has been added to the response with status 200 for the GET operation extension-list-extensions at the path /v2/extensions.

• The required property /anyOf[#/components/schemas/de.mittwald.v1.marketplace.Extension]/publishedAt has been added to the response with status 200 for the GET operation extension-get-extension at the path /v2/extensions/{extensionId}.

• The optional property recipient/leitwegId has been added to the response with status 200 for the GET operation invoice-detail at the path /v2/invoices/{invoiceId}.

• The optional property recipient/purchaseOrderReference has been added to the response with status 200 for the GET operation invoice-detail at the path /v2/invoices/{invoiceId}.

• The required property /items/action/anyOf[#/components/schemas/de.mittwald.v1.activitylog.AppInstallationDesiredSystemSoftwareDeleted]/parameters/appInstallation has been added to the response with status 200 for the GET operation project-list-project-activities at the path /v2/projects/{projectId}/activities.

• The required property /items/action/anyOf[#/components/schemas/de.mittwald.v1.activitylog.AppInstallationDesiredSystemSoftwareSet]/parameters/appInstallation has been added to the response with status 200 for the GET operation project-list-project-activities at the path /v2/projects/{projectId}/activities.

• The optional property /items/sourceAppInstallationId has been added to the response with status 200 for the GET operation app-list-appinstallations at the path /v2/projects/{projectId}/app-installations.

• The optional property /items/staging has been added to the response with status 200 for the GET operation app-list-appinstallations at the path /v2/projects/{projectId}/app-installations.

• The required property parentCustomerId has been added to the response with status 200 for the GET operation extension-get-extension-instance-for-project at the path /v2/projects/{projectId}/extensions/{extensionId}.

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

Detailed changes

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

• ⚠️ Breaking: removed the media type 'application/json' for the response with the status '204'

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

Changes in "Disable an extension instance"

• ⚠️ Breaking: removed the media type 'application/json' for the response with the status '204'

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

Changes in "Enable an extension instance"

• ⚠️ Breaking: removed the media type 'application/json' for the response with the status '204'

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

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

• added the new 'hasOrdersInProgress' enum value to the '/items/deletionProhibitedBy/items/' response property for the response status '200'

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

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

Changes in "Get a customer profile"

• added the new 'hasOrdersInProgress' enum value to the 'deletionProhibitedBy/items/' response property for the response status '200'

• added the optional property 'owner/purchaseOrderReference' to the response with the '200' status

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

Changes in "List app installations that a user has access to"

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

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

For details, refer to the GET/v2/app-installations/ endpoint.

Changes in "Get an app installation"

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

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

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

Changes in "Detach a staging app installation from its source"

• endpoint added

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

Changes in "Promote a staging app installation"

• endpoint added

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

Changes in "Request a staging for an app installation"

• endpoint added

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

Changes in "List Extensions of own contributor"

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

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

• added the optional property 'publishedAt' 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 'createdAt' to the response with the '200' status

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

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

Changes in "List incoming Invoices of a contributor"

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

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

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

Changes in "Create a new customer profile"

• added the new optional request property 'owner/purchaseOrderReference'

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

Changes in "Update a customer profile"

• added the new optional request property 'owner/purchaseOrderReference'

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

Changes in "Get the extension instance of a specific customer and extension, if existing"

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

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

Changes in "Get InvoiceSettings of a Customer"

• added the optional property 'recipient/leitwegId' to the response with the '200' status

• added the optional property 'recipient/purchaseOrderReference' to the response with the '200' status

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

Changes in "Update InvoiceSettings of a Customer"

• added the new optional request property 'recipient/leitwegId'

• added the new optional request property 'recipient/purchaseOrderReference'

• added the optional property 'recipient/leitwegId' to the response with the '200' status

• added the optional property 'recipient/purchaseOrderReference' to the response with the '200' status

For details, refer to the PUT/v2/customers/{customerId}/invoice-settings/ endpoint.

Changes in "List Invoices of a Customer"

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

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

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

Changes in "Get details of an Invoice"

• added the optional property 'recipient/leitwegId' to the response with the '200' status

• added the optional property 'recipient/purchaseOrderReference' to the response with the '200' status

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

Changes in "Check if a Domain is available to transfer"

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

For details, refer to the POST/v2/domain-transferable/ endpoint.

Changes in "List extension instances"

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

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

For details, refer to the GET/v2/extension-instances/ endpoint.

Changes in "Get an extension instance"

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

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

Changes in "List Extensions"

• added the new enum value 'relevance' to the 'query' request parameter 'sort'

• added the required property '/items/publishedAt' 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.UnpublishedExtension]/publishedAt' to the response with the '200' status

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

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

Changes in "Get details of an Invoice"

• added the optional property 'recipient/leitwegId' to the response with the '200' status

• added the optional property 'recipient/purchaseOrderReference' to the response with the '200' status

For details, refer to the GET/v2/invoices/{invoiceId}/ endpoint.

Changes in "Get the activities of a project"

• added the required property '/items/action/anyOf[#/components/schemas/de.mittwald.v1.activitylog.AppInstallationDesiredSystemSoftwareDeleted]/parameters/appInstallation' to the response with the '200' status

• added the required property '/items/action/anyOf[#/components/schemas/de.mittwald.v1.activitylog.AppInstallationDesiredSystemSoftwareSet]/parameters/appInstallation' to the response with the '200' status

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

Changes in "List app installations belonging to a Project"

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

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

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

Changes in "Get the extension instance of a specific project and extension, if existing"

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

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

Client package releases

mittwald JavaScript SDK Release 4.449.0

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

The mittwald JavaScript SDK version 4.448.2 has been released on August 27, 2026. This update includes a bug fix related to the continuous integration process, specifically addressing issues with recovering from partial npm publishes via Lerna's from-package command. For more details, you can view the release on GitHub.

mittwald JavaScript SDK Release 4.448.1

The mittwald JavaScript SDK version 4.448.1 has been released on August 27, 2026. This release includes a bug fix related to the continuous integration process, specifically pinning the development publish job to the development branch and restoring version 4.448.0. For more details, you can view the release on GitHub: mittwald JavaScript SDK 4.448.1.

mittwald JavaScript SDK Release 0.0.0-development-f13d74a-20260826.0

The latest prerelease of the mittwald JavaScript SDK, version 0.0.0-development-f13d74a-20260826.0, is now available. This update includes a feature enhancement with an updated generated client. For more details, you can view the release on GitHub here.

mittwald JavaScript SDK Release 4.448.0

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

The mittwald JavaScript SDK version 4.447.0 has been released. This update includes a feature enhancement with an updated generated client. For more details, you can view the release on GitHub here.

mittwald JavaScript SDK Release 4.446.0

The mittwald JavaScript SDK has been updated to version 4.446.0. This release includes the following feature:

• Updated the generated client to enhance functionality (commit d73e504).

For more details, please visit the release page.