Breaking (!) API changes for v2 API, September 18 to September 25

This week, the mittwald API introduces several changes, including the addition of new optional request parameters and properties, the requirement of request bodies for specific endpoints, and updates to response properties, enhancing the overall functionality and flexibility of the API.

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 response property /anyOf[#/components/schemas/de.mittwald.v1.marketplace.UnpublishedExtension]/context became optional for the status 200 in the GET operation for the path /v2/extensions/{extensionId}. This is a breaking change.
• The request body became required for the POST operations for the paths /v2/users/self/spotlights/{spotlightId} and /v2/users/self/spotlights/{spotlightId}/feedback. This is a breaking change.
• Added the new optional 'header' request parameter Accept-Language for the GET operations for the paths /v2/app-installations/{appInstallationId}/error-analysis, /v2/container-image-config, and /v2/stacks/{stackId}/services/{serviceId}/log-analysis.
• Added the new optional request property projectId for the POST operation for the path /v2/domain-transferable.
• Added the required property reasons/enabledIngressInOtherProject to the response with the 200 status for the POST operation for the path /v2/domain-transferable.
• New endpoints were added for the GET operations for the paths /v2/leaked-passwords/{passwordHashPrefix} and /v2/oauth2/clients/{oauthClientId}.
• Removed the pattern |^\+([0-9]{2,3}|1)-[0-9]{2,5}-[0-9]+$ from the request property contact/phoneNumber for the POST operation for the path /v2/relocation.
• Added the new optional request properties x-description and x-update-schedule for the PATCH operation for the path /v2/stacks/{stackId}.
• The request property owner became optional for the POST operation for the path /v2/users/self/spotlights/{spotlightId}/feedback.

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

Detailed changes

Changes in "Get an Extension"

• ⚠️ Breaking: the response property '/anyOf[#/components/schemas/de.mittwald.v1.marketplace.UnpublishedExtension]/context' became optional for the status '200'

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

Changes in "Submit your usage of the spotlight"

• ⚠️ Breaking: request body became required

For details, refer to the POST/v2/users/self/spotlights/{spotlightId}/ endpoint.

Changes in "Submit your spotlight usage"

• ⚠️ Breaking: request body became required

• the request property 'owner' became optional

For details, refer to the POST/v2/users/self/spotlights/{spotlightId}/feedback/ endpoint.

Changes in "Get an analysis of the error of an app installation"

• added the new optional 'header' request parameter 'Accept-Language'

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

Changes in "Get a ContainerImageConfig"

• added the new optional 'header' request parameter 'Accept-Language'

For details, refer to the GET/v2/container-image-config/ endpoint.

Changes in "Check if a Domain is available to transfer"

• added the new optional request property 'projectId'

• added the required property 'reasons/enabledIngressInOtherProject' to the response with the '200' status

For details, refer to the POST/v2/domain-transferable/ endpoint.

Changes in "Check if a password is leaked"

• endpoint added

For details, refer to the GET/v2/leaked-passwords/{passwordHashPrefix}/ endpoint.

Changes in "Get a specific OAuth2 client"

• endpoint added

For details, refer to the GET/v2/oauth2/clients/{oauthClientId}/ endpoint.

Changes in "Relocate an external Project to mittwald"

• removed the pattern '|^+([0-9]{2,3}|1)-[0-9]{2,5}-[0-9]+$' from the request property 'contact/phoneNumber'

For details, refer to the POST/v2/relocation/ endpoint.

Changes in "Create, update or delete Services or Volumes belonging to a Stack"

• added the new optional request property 'x-description'

• added the new optional request property 'x-update-schedule'

For details, refer to the PATCH/v2/stacks/{stackId}/ endpoint.

Changes in "Get an analysis of the logs belonging to a Service"

• added the new optional 'header' request parameter 'Accept-Language'

For details, refer to the GET/v2/stacks/{stackId}/services/{serviceId}/log-analysis/ endpoint.

Client package releases

mittwald PHP SDK v2.2.2 Release Summary

The mittwald PHP SDK has released version 2.2.2, which introduces new features, enhancements, and adjustments to improve user experience and functionality.

New Features

• Leaked Password Verification: A new endpoint has been added to check if a password has been compromised. By submitting a passwordHashPrefix (up to 5 characters), the API returns all matching password hashes with their prevalence counts, allowing applications to warn users about leaked credentials.

Enhancements

• Domain Transferability Checks: The domain transfer validation API has been enhanced to support project-specific contexts and prevent ingress conflicts. The request body now includes projectId to specify the target project, and the response includes enabledIngressInOtherProject, which indicates if an enabled ingress for the domain exists in another project.

Adjustments

• Relocation Phone Number Validation: The validation rules for the phoneNumber field in relocation requests have been relaxed by removing a strict regex constraint, allowing more flexible phone number formats.

For more details, visit the release page.

mittwald PHP SDK v2.2.1 Release Summary

The mittwald PHP SDK has been updated to version 2.2.1. This release introduces several new features and enhancements, particularly focusing on Marketplace OAuth2 client management, webhook execution resumption, and User spotlight tracking. Additionally, it includes improvements in extension listing capabilities and updates to request/response schemas for container service declarations.

Key Features and Enhancements:

• Marketplace Enhancements:

  • New endpoint contributorGetOauthClient for detailed OAuth2 client information.
  • extensionResumeWebhookExecutionForExtensionInstance to resume suspended webhook executions.
  • New filtering option contract.interactionRequired for extension instances.

• User Spotlight Management:

  • getSpotlightInfo to fetch spotlight status and decision details.
  • spotlightFeedback for submitting user feedback and decisions.
  • spotlightUsage for recording usage metrics.

Deprecations:

• Stack properties description and updateSchedule are deprecated in favor of x-description and x-update-schedule.
• restartPolicy in service declarations is deprecated; use restart instead.
• The owner field in spotlight feedback and usage requests is deprecated.

API Behavior & Compatibility Updates:

• Clarification on declarative stack PUT endpoint behavior.
• The context field in UnpublishedExtension is now optional.

Documentation Updates:

• Updated docblocks and validation schemas.
• Added comprehensive request builders and response containers for new endpoints.

For more details, please refer to the release page.

mittwald JavaScript SDK Release 4.471.0

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

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

The mittwald JavaScript SDK has been updated to version 4.469.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release notes on GitHub.

mittwald JavaScript SDK Release 4.468.0

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

mittwald JavaScript SDK Release 4.467.0

The mittwald JavaScript SDK has been updated to version 4.467.0. This release introduces a new feature that allows the acceptance of JavaScript Date objects for date-time request values, addressing issues raised in #209. For more details, you can view the release on GitHub here.

mittwald JavaScript SDK Release 4.466.0

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