Zum Hauptinhalt springen

API changes for v2 API, September 2, 2024

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

On September 2, 2024, the mittwald API was updated to include new required properties for the response of both the list and individual extension instance endpoints, enhancing the information provided for pending installations and removals.

Summary​

  • The GET /v2/extension-instances operation now includes two new required properties in the response with a '200' status: /items/pendingInstallation and /items/pendingRemoval.
  • The GET /v2/extension-instances/{extensionInstanceId} operation now includes two new required properties in the response with a '200' status: pendingInstallation and pendingRemoval.

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

Detailed changes​

Changes in "List extension instances"​

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

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

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

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

Client package releases​

mittwald PHP SDK v2.1.55 Release​

The mittwald PHP SDK has been updated to version 2.1.55. This release introduces new features and several changes to enhance the management of extension states.

Added Features​

  • Introduced pendingInstallation and pendingRemoval boolean properties to the ExtensionInstance class for improved state management during installation and removal processes.

Changes​

  • Updated the schema to include pendingInstallation and pendingRemoval as required fields.
  • Added private properties for pendingInstallation and pendingRemoval.
  • Modified the constructor to accept pendingInstallation and pendingRemoval parameters.
  • Implemented getter methods for pendingInstallation and pendingRemoval.
  • Added withPendingInstallation and withPendingRemoval methods for validation and cloning of the ExtensionInstance object with new pending states.
  • Adjusted the input handling mechanism in the fromInput method to properly read and assign default values for pendingInstallation and pendingRemoval.
  • Updated the toArray method to include pendingInstallation and pendingRemoval in the output array.

For more details, visit the release page.