Zum Hauptinhalt springen

API changes for v2 API, July 25 to August 1

mittwald machine
mittwald machine
mittwald Bot user; hail our robot overlords!

During the week of July 25 to August 1, 2025, the mittwald API introduced several updates, including the addition of new request properties, changes in property types, the removal of deprecated properties, and the introduction of new endpoints for managing mail address backups.

Summary

  • In the PATCH operation for the path /v2/contributors/{contributorId}/extensions/{extensionId}, the following changes were made:

    • The request property detailedDescriptions became nullable to express the possibility to remove them for unverified contributors.
    • The request property externalFrontends became nullable to express the possibility to remove them.
    • The request property frontendFragments became nullable to express the possibility to remove them.
    • The request property webhookUrls became nullable to express the possibility to remove them.
  • In the GET operation for the path /v2/customers/{customerId}/extensions/{extensionId}, the response property contributorId became required for the status '200'.

  • In the GET operation for the path /v2/extension-instances, the response property /items/contributorId became required for the status '200'.

  • In the GET operation for the path /v2/extension-instances/{extensionInstanceId}, the response property contributorId became required for the status '200'.

  • In the GET operation for the path /v2/extensions, a new optional request parameter includeDeprecated was added.

  • In the GET operation for the path /v2/mail-addresses/{mailAddressId}/backups, an endpoint was added to list backups belonging to a MailAddress.

  • In the POST operation for the path /v2/mail-addresses/{mailAddressId}/backups/{backupId}/recovery, an endpoint was added to recover emails for a MailAddress from a backup.

  • In the GET operation for the path /v2/notifications, a new optional request parameter severity was added.

  • In the GET operation for the path /v2/projects/{projectId}/extensions/{extensionId}, the response property contributorId became required for the status '200'.

  • In the GET operation for the path /v2/projects/{projectId}/storage-space-statistics, an optional property meta/lastExceedanceLimitInBytes was added to the response with the '200' status.

  • In the GET operation for the path /v2/servers/{serverId}/storage-space-statistics, an optional property meta/lastExceedanceLimitInBytes was added to the response with the '200' status.

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

Detailed changes

Changes in "Patch Extension"

  • the request property 'detailedDescriptions' became nullable

  • the request property 'externalFrontends' became nullable

  • the request property 'frontendFragments' became nullable

  • the request property 'webhookUrls' became nullable

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

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

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

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

Changes in "List extension instances"

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

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

Changes in "Get an extension instance"

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

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

Changes in "List Extensions"

  • added the new optional 'query' request parameter 'includeDeprecated'. Although the default value is "false", the behavior of this endpoint has not changed, because at the same time, the first "deprecated" extension was introduced.

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

Changes in "List backups belonging to a mail address"

  • endpoint added

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

Changes in "Recover emails for a mail address from a backup"

  • endpoint added

For details, refer to the POST/v2/mail-addresses/{mailAddressId}/backups/{backupId}/recovery/ endpoint.

Changes in "List all unread notifications"

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

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

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

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

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

Changes in "Get storage space Statistics belonging to a Project"

  • added the optional property 'meta/lastExceedanceLimitInBytes' to the response with the '200' status

For details, refer to the GET/v2/projects/{projectId}/storage-space-statistics/ endpoint.

Changes in "Get storage space Statistics belonging to a Server"

  • added the optional property 'meta/lastExceedanceLimitInBytes' to the response with the '200' status

For details, refer to the GET/v2/servers/{serverId}/storage-space-statistics/ endpoint.

Client package releases

mittwald JavaScript SDK Release 4.193.0

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

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

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