Breaking (!) API changes for v2 API, August 12, 2024

This document contains a machine-generated summary of the API changes for August 12, 2024. The API changes are based on the diff between the OpenAPI schemas of the two versions.

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 request property orderData/oneOf[#/components/schemas/de.mittwald.v1.order.DomainOrderPreview]/projectId has become required in the POST /v2/order-previews operation. This is a breaking change.
• The type/format of the userId path request parameter has changed from string/uuid to string/'' in the DELETE /v2/user/{userId}/avatar and DELETE /v2/user/{userId}/phone operations. This is a breaking change.
• The type/format of the userId path request parameter has been generalized from ''/'' to string/'' in the following operations:
  • GET /v2/users/{userId} (Get profile information for a user)
  • PUT /v2/users/{userId} (Change personal information)
  • POST /v2/users/{userId}/actions/verify-phone (Verify phone number)
  • DELETE /v2/users/{userId}/avatar (Remove Avatar)
  • POST /v2/users/{userId}/avatar (Request a new avatar image upload)
  • GET /v2/users/{userId}/feedback (Submitted feedback of the given user)
  • DELETE /v2/users/{userId}/phone (Remove phone number)
  • POST /v2/users/{userId}/phone (Add phone number and start verification process)
  • GET /v2/users/{userId}/settings (Get personalized settings)
  • PUT /v2/users/{userId}/settings (Update personalized GUI settings)

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

Detailed changes

Changes in "Preview Order"

• ⚠️ Breaking: the request property 'orderData/oneOf[#/components/schemas/de.mittwald.v1.order.DomainOrderPreview]/projectId' became required

For details, refer to the POST/v2/order-previews/ endpoint.

Changes in "Remove Avatar"

• ⚠️ Breaking: for the 'path' request parameter 'userId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the DELETE/v2/user/{userId}/avatar/ endpoint.

Changes in "remove your PhoneNumber"

• ⚠️ Breaking: for the 'path' request parameter 'userId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the DELETE/v2/user/{userId}/phone/ endpoint.

Changes in "Get profile information for a user"

• for the 'path' request parameter 'userId', the type/format was generalized from ''/'' to 'string'/''

For details, refer to the GET/v2/users/{userId}/ endpoint.

Changes in "Change personal information"

• for the 'path' request parameter 'userId', the type/format was generalized from ''/'' to 'string'/''

For details, refer to the PUT/v2/users/{userId}/ endpoint.

Changes in "Verify phone number"

• for the 'path' request parameter 'userId', the type/format was generalized from ''/'' to 'string'/''

For details, refer to the POST/v2/users/{userId}/actions/verify-phone/ endpoint.

Changes in "Remove Avatar"

• for the 'path' request parameter 'userId', the type/format was generalized from ''/'' to 'string'/''

For details, refer to the DELETE/v2/users/{userId}/avatar/ endpoint.

Changes in "Request a new avatar image upload"

• for the 'path' request parameter 'userId', the type/format was generalized from ''/'' to 'string'/''

For details, refer to the POST/v2/users/{userId}/avatar/ endpoint.

Changes in "Submitted feedback of the given user"

• for the 'path' request parameter 'userId', the type/format was generalized from ''/'' to 'string'/''

For details, refer to the GET/v2/users/{userId}/feedback/ endpoint.

Changes in "Remove phone number"

• for the 'path' request parameter 'userId', the type/format was generalized from ''/'' to 'string'/''

For details, refer to the DELETE/v2/users/{userId}/phone/ endpoint.

Changes in "Add phone number and start verification process"

• for the 'path' request parameter 'userId', the type/format was generalized from ''/'' to 'string'/''

For details, refer to the POST/v2/users/{userId}/phone/ endpoint.

Changes in "Get personalized settings"

• for the 'path' request parameter 'userId', the type/format was generalized from ''/'' to 'string'/''

For details, refer to the GET/v2/users/{userId}/settings/ endpoint.

Changes in "Update personalized GUI settings"

• for the 'path' request parameter 'userId', the type/format was generalized from ''/'' to 'string'/''

For details, refer to the PUT/v2/users/{userId}/settings/ endpoint.