Skip to main content

API changes for v2 API, May 8 to May 15

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

This week's update to the mittwald API includes significant changes such as modifications to the authentication response structure, the addition of new endpoints for contact verifications, and the introduction of optional properties across various responses.

Summary​

  • The optional property '/items/appVersion/lastChangeBy' has been added to the response for the GET operation at the path /v2/app-installations with the status '200'.
  • The optional property '/items/appVersion/previous' has been added to the response for the GET operation at the path /v2/app-installations with the status '200'.
  • The optional property '/items/systemSoftware/items/systemSoftwareVersion/lastChangeBy' has been added to the response for the GET operation at the path /v2/app-installations with the status '200'.
  • The optional property '/items/systemSoftware/items/systemSoftwareVersion/previous' has been added to the response for the GET operation at the path /v2/app-installations with the status '200'.
  • The optional property 'appVersion/lastChangeBy' has been added to the response for the GET operation at the path /v2/app-installations/{appInstallationId} with the status '200'.
  • The optional property 'appVersion/previous' has been added to the response for the GET operation at the path /v2/app-installations/{appInstallationId} with the status '200'.
  • The optional property 'systemSoftware/items/systemSoftwareVersion/lastChangeBy' has been added to the response for the GET operation at the path /v2/app-installations/{appInstallationId} with the status '200'.
  • The optional property 'systemSoftware/items/systemSoftwareVersion/previous' has been added to the response for the GET operation at the path /v2/app-installations/{appInstallationId} with the status '200'.
  • The new optional request parameter 'cookieOnly' has been added to the POST operation at the path /v2/authenticate.
  • The new optional request parameter 'cookieOnly' has also been added to the POST operation at the path /v2/authenticate-mfa.
  • The success response with the status '204' has been added to the POST operation at the path /v2/authenticate.
  • The success response with the status '204' has been added to the POST operation at the path /v2/authenticate-mfa.
  • The endpoint for listing contact verifications has been added at the path /v2/contact-verifications.
  • The endpoint for getting a contact verification has been added at the path /v2/contact-verifications/{contactVerificationId}.
  • The endpoint for resending a contact verification email has been added at the path /v2/contact-verifications/{contactVerificationId}/actions/resend-contact-verification-email.
  • The media type 'application/json' has been added for the response with the status '412' for the DELETE operation at the path /v2/contributors/{contributorId}.
  • The optional property '/items/deletionDeadline' has been added to the response for the GET operation at the path /v2/contributors/{contributorId}/extensions with the status '200'.
  • The optional property '/items/isDeletionScheduled' has been added to the response for the GET operation at the path /v2/contributors/{contributorId}/extensions with the status '200'.
  • The optional property 'deletionDeadline' has been added to the response for the GET operation at the path /v2/contributors/{contributorId}/extensions/{extensionId} with the status '200'.
  • The optional property 'isDeletionScheduled' has been added to the response for the GET operation at the path /v2/contributors/{contributorId}/extensions/{extensionId} with the status '200'.
  • The optional property 'deletionDeadline' has been added to the response for the PATCH operation at the path /v2/contributors/{contributorId}/extensions/{extensionId} with the status '200'.
  • The optional property 'isDeletionScheduled' has been added to the response for the PATCH operation at the path /v2/contributors/{contributorId}/extensions/{extensionId} with the status '200'.
  • The optional property 'extensionDeletionDeadline' has been added to the response for the GET operation at the path /v2/projects/{projectId}/extensions/{extensionId} with the status '200'.
  • The API operation id 'user-check-token' has been removed and replaced with 'deprecated-user-check-token' for the POST operation at the path /v2/users/self/credentials/token.
  • The endpoint for checking the status of the current session has been added at the path /v2/users/self/sessions/current/status.

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

Detailed changes​

Changes in "Authenticate yourself to get an access token"​

  • removed the optional property 'message' from the response with the '401' status

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

  • added '#/components/schemas/de.mittwald.v1.commons.ValidationErrors, #/components/schemas/de.mittwald.v1.commons.Error' to the response body 'oneOf' list for the response status '401'

  • added the success response with the status '204'

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

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

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

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

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

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

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

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

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

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

Changes in "Validate your second factor"​

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

  • added the success response with the status '204'

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

Changes in "List Contact-Verifications belonging to the executing user"​

  • endpoint added

For details, refer to the GET/v2/contact-verifications/ endpoint.

Changes in "Get a Contact-Verification"​

  • endpoint added

For details, refer to the GET/v2/contact-verifications/{contactVerificationId}/ endpoint.

Changes in "Resends a Contact-Verification email"​

  • endpoint added

For details, refer to the POST/v2/contact-verifications/{contactVerificationId}/actions/resend-contact-verification-email/ endpoint.

Changes in "Delete a contributor"​

  • added the media type 'application/json' for the response with the status '412'

For details, refer to the DELETE/v2/contributors/{contributorId}/ endpoint.

Changes in "List Extensions of own contributor"​

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

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

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

Changes in "Get Extension of own contributor"​

  • added the optional property 'deletionDeadline' to the response with the '200' status

  • added the optional property 'isDeletionScheduled' to the response with the '200' status

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

Changes in "Patch Extension"​

  • added the optional property 'deletionDeadline' to the response with the '200' status

  • added the optional property 'isDeletionScheduled' to the response with the '200' status

For details, refer to the PATCH/v2/contributors/{contributorId}/extensions/{extensionId}/ endpoint.

Changes in "Get the extension instance of a specific customer and extension, if existing"​

  • added the optional property 'extensionDeletionDeadline' to the response with the '200' status

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

Changes in "List extension instances"​

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

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

Changes in "List Extensions"​

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

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

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

Changes in "Get an Extension"​

  • added the optional property '/anyOf[#/components/schemas/de.mittwald.v1.marketplace.Extension]/deletionDeadline' to the response with the '200' status

  • added the optional property '/anyOf[#/components/schemas/de.mittwald.v1.marketplace.Extension]/isDeletionScheduled' to the response with the '200' status

  • added the optional property '/anyOf[#/components/schemas/de.mittwald.v1.marketplace.UnpublishedExtension]/deletionDeadline' to the response with the '200' status

  • added the optional property '/anyOf[#/components/schemas/de.mittwald.v1.marketplace.UnpublishedExtension]/isDeletionScheduled' to the response with the '200' status

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

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

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

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

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

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

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

Changes in "Get the extension instance of a specific project and extension, if existing"​

  • added the optional property 'extensionDeletionDeadline' to the response with the '200' status

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

Changes in "user-check-token"​

  • api operation id 'user-check-token' removed and replaced with 'deprecated-user-check-token'

For details, refer to the unknown operation user-check-token endpoint.

Changes in "Check status of the current session"​

  • endpoint added

For details, refer to the GET/v2/users/self/sessions/current/status/ endpoint.

Client package releases​

mittwald JavaScript SDK Release 4.366.0​

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

mittwald JavaScript SDK Release 4.365.0​

The mittwald JavaScript SDK has been updated to version 4.365.0. This release includes the following feature:

For more details, you can view the release on GitHub.

mittwald JavaScript SDK Release 4.364.1​

The mittwald JavaScript SDK has been updated to version 4.364.1. This release includes a version bump for the package root. For more details, you can view the release on GitHub here.

mittwald JavaScript SDK Release 4.364.0​

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

mittwald JavaScript SDK Release 4.363.0​

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

The mittwald JavaScript SDK has been updated to version 4.362.0. This release includes the following feature:

  • Updated the generated client, enhancing the SDK's functionality and performance.

For more details, you can view the release on GitHub: mittwald JavaScript SDK 4.362.0.