Skip to main content

Breaking (!) API changes for v2 API, September 30, 2024

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

On September 30, 2024, the mittwald API introduced several important changes, including the requirement of 'email' and 'password' properties for the MFA authentication request, a decrease in the minimum value for the 'page' query parameter, and the addition of required response properties for specific user account operations.

Summary

  • The request properties 'email' and 'password' have both become required for the POST operation user-authenticate-mfa at the path /v2/authenticate-mfa. This is a breaking change.
  • The minimum value for the 'query' request parameter 'page' has been decreased from '1.00' to '0.00' for the GET operation app-list-appinstallations at the path /v2/projects/{projectId}/app-installations.
  • The response property '/allOf[subschema #2]/name' has become required for the status '202' in both the DELETE operation user-delete-user at the path /v2/users/self and the PUT operation user-change-password at the path /v2/users/self/credentials/password.

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

Detailed changes

Changes in "Validate your second factor"

  • ⚠️ Breaking: the request property 'email' became required

  • ⚠️ Breaking: the request property 'password' became required

For details, refer to the POST/v2/authenticate-mfa/ endpoint.

Changes in "List app installations belonging to a Project"

  • for the 'query' request parameter 'page', the min was decreased from '1.00' to '0.00'

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

Changes in "Delete your account and all your personal data"

  • the response property '/allOf[subschema #2]/name' became required for the status '202'

For details, refer to the DELETE/v2/users/self/ endpoint.

Changes in "Change your password"

  • the response property '/allOf[subschema #2]/name' became required for the status '202'

For details, refer to the PUT/v2/users/self/credentials/password/ endpoint.