Zum Hauptinhalt springen

API changes for v2 API, May 15 to May 22

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

This week, the mittwald API introduces several enhancements, including the addition of optional properties to various responses, new optional request parameters for improved query capabilities, and the introduction of new endpoints for updating MySQL and Redis databases.

Summary​

  • The optional property /items/appVersion/lastChangedAt has been added to the response with a 200 status for the GET operation on the path /v2/app-installations and /v2/projects/{projectId}/app-installations.
  • The optional property /items/systemSoftware/items/systemSoftwareVersion/lastChangedAt has been added to the response with a 200 status for the GET operation on the path /v2/app-installations and /v2/projects/{projectId}/app-installations.
  • The optional property appVersion/lastChangedAt has been added to the response with a 200 status for the GET operation on the path /v2/app-installations/{appInstallationId}.
  • The optional property systemSoftware/items/systemSoftwareVersion/lastChangedAt has been added to the response with a 200 status for the GET operation on the path /v2/app-installations/{appInstallationId}.
  • A new optional request property domain has been added for the POST operation on the path /v2/app-installations/{appInstallationId}/actions/copy.
  • The optional property additionalItems/items/tariffChange/isForced has been added to the response with a 200 status for the GET operation on the paths /v2/certificates/{certificateId}/contract, /v2/contracts/{contractId}, /v2/customers/{customerId}/ai-hosting/contract, /v2/customers/{customerId}/lead-fyndr-profile/contract, /v2/customers/{customerId}/contracts, /v2/domains/{domainId}/contract, /v2/licenses/{licenseId}/contract, /v2/mail-addresses/{mailAddressId}/contract, /v2/projects/{projectId}/contract, and /v2/servers/{serverId}/contract.
  • The optional property baseItem/tariffChange/isForced has been added to the response with a 200 status for the GET operation on the paths /v2/certificates/{certificateId}/contract, /v2/contracts/{contractId}, /v2/customers/{customerId}/ai-hosting/contract, /v2/customers/{customerId}/lead-fyndr-profile/contract, /v2/customers/{customerId}/contracts, /v2/domains/{domainId}/contract, /v2/licenses/{licenseId}/contract, /v2/mail-addresses/{mailAddressId}/contract, and /v2/projects/{projectId}/contract.
  • The optional property tariffChange/isForced has been added to the response with a 200 status for the GET operation on the paths /v2/contracts/{contractId}/base-items and /v2/contracts/{contractId}/items/{contractItemId}.
  • New optional request parameters searchTerm have been added for the GET operations on the paths /v2/customers/{customerId}/invites, /v2/customers/{customerId}/memberships, /v2/projects/{projectId}/invites, and /v2/projects/{projectId}/memberships.
  • Two new endpoints have been added for the PATCH operations on the paths /v2/mysql-databases/{mysqlDatabaseId} and /v2/redis-databases/{redisDatabaseId}.

Note: No breaking changes have been indicated in this update.

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

Detailed changes​

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

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

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

  • added the optional property 'systemSoftware/items/systemSoftwareVersion/lastChangedAt' to the response with the '200' status

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

Changes in "Request a copy of an app installation"​

  • added the new optional request property 'domain'

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

Changes in "Return the Contract for the given Certificate"​

  • added the optional property 'additionalItems/items/tariffChange/isForced' to the response with the '200' status

  • added the optional property 'baseItem/tariffChange/isForced' to the response with the '200' status

For details, refer to the GET/v2/certificates/{certificateId}/contract/ endpoint.

Changes in "Returns the Contract with the given ID"​

  • added the optional property 'additionalItems/items/tariffChange/isForced' to the response with the '200' status

  • added the optional property 'baseItem/tariffChange/isForced' to the response with the '200' status

For details, refer to the GET/v2/contracts/{contractId}/ endpoint.

Changes in "Return the BaseItem of the Contract with the given ID"​

  • added the optional property 'tariffChange/isForced' to the response with the '200' status

For details, refer to the GET/v2/contracts/{contractId}/base-items/ endpoint.

Changes in "Get the ContractItem with the given ID"​

  • added the optional property 'tariffChange/isForced' to the response with the '200' status

For details, refer to the GET/v2/contracts/{contractId}/items/{contractItemId}/ endpoint.

Changes in "Return the AI Hosting Contract for the given Customer"​

  • added the optional property 'additionalItems/items/tariffChange/isForced' to the response with the '200' status

  • added the optional property 'baseItem/tariffChange/isForced' to the response with the '200' status

For details, refer to the GET/v2/customers/{customerId}/ai-hosting/contract/ endpoint.

Changes in "Return a list of Contracts for the given Customer"​

  • added the optional property '/items/additionalItems/items/tariffChange/isForced' to the response with the '200' status

  • added the optional property '/items/baseItem/tariffChange/isForced' to the response with the '200' status

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

Changes in "List Invites belonging to a Customer"​

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

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

Changes in "Return the Contract for the given LeadFyndrProfile"​

  • added the optional property 'additionalItems/items/tariffChange/isForced' to the response with the '200' status

  • added the optional property 'baseItem/tariffChange/isForced' to the response with the '200' status

For details, refer to the GET/v2/customers/{customerId}/lead-fyndr-profile/contract/ endpoint.

Changes in "List Memberships belonging to a Customer"​

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

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

Changes in "Return the Contract for the given Domain"​

  • added the optional property 'additionalItems/items/tariffChange/isForced' to the response with the '200' status

  • added the optional property 'baseItem/tariffChange/isForced' to the response with the '200' status

For details, refer to the GET/v2/domains/{domainId}/contract/ endpoint.

Changes in "Return the Contract for the given License"​

  • added the optional property 'additionalItems/items/tariffChange/isForced' to the response with the '200' status

  • added the optional property 'baseItem/tariffChange/isForced' to the response with the '200' status

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

Changes in "Return the Contract for the given Mail Address"​

  • added the optional property 'additionalItems/items/tariffChange/isForced' to the response with the '200' status

  • added the optional property 'baseItem/tariffChange/isForced' to the response with the '200' status

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

Changes in "Update a MySQL database"​

  • endpoint added

For details, refer to the PATCH/v2/mysql-databases/{mysqlDatabaseId}/ endpoint.

Changes in "List app installations belonging to a Project"​

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

  • added the optional property '/items/systemSoftware/items/systemSoftwareVersion/lastChangedAt' to the response with the '200' status

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

Changes in "Return the Contract for the given Project"​

  • added the optional property 'additionalItems/items/tariffChange/isForced' to the response with the '200' status

  • added the optional property 'baseItem/tariffChange/isForced' to the response with the '200' status

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

Changes in "List Invites belonging to a Project"​

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

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

Changes in "List Memberships belonging to a Project"​

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

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

Changes in "Update a Redis database"​

  • endpoint added

For details, refer to the PATCH/v2/redis-databases/{redisDatabaseId}/ endpoint.

Changes in "Return the Contract for the given Server"​

  • added the optional property 'additionalItems/items/tariffChange/isForced' to the response with the '200' status

  • added the optional property 'baseItem/tariffChange/isForced' to the response with the '200' status

For details, refer to the GET/v2/servers/{serverId}/contract/ endpoint.

Client package releases​

mittwald JavaScript SDK Release 4.373.0​

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

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

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

mittwald JavaScript SDK Release 4.370.0​

The mittwald JavaScript SDK has been updated to version 4.370.0. This release includes an update to the generated client, enhancing the functionality and performance of the SDK. For more details, you can view the release on GitHub.

mittwald JavaScript SDK Release 4.369.0​

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

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

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