Skip to main content

API changes for v2 API, June 19 to June 26

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

This week's changes are primarily spec cleanup and new endpoint additions. The conversation-related changes are technically breaking but have no practical impact on existing integrations — the actual API responses remain unchanged.

Summary​

  • The conversation response schemas for GET /v2/conversations and GET /v2/conversations/{conversationId} have been restructured. Fields like conversationId, createdAt, mainUser, shortId, status, title, visibility, and all previously optional fields have been moved into the BasicConversation schema and are now composed via allOf. The actual response payloads are unchanged — this is a spec-level reorganization only.
  • The following internal fields have been removed from the GET /v2/conversations/{conversationId}/members and GET /v2/conversations/{conversationId}/messages responses: atlasGroup, department, and group. These fields were accidentally exposed in the spec but were never returned to external API users. Their removal corrects the spec to match actual behavior.
  • The schemas de.mittwald.v1.conversation.Department and de.mittwald.v1.conversation.Group have been removed from the API, as they were never part of the public API surface.
  • New endpoints have been added:
    • GET /v2/container-templates to list Container Templates.
    • GET /v2/container-templates/{templateId} to get a Container Template by ID.
    • GET /v2/customers/{customerId}/projects to list Projects belonging to a Customer.
    • GET /v2/projects/{projectId}/domain-migrations to list Domain-Migrations belonging to a Project.
    • POST /v2/projects/{projectId}/stacks to create a Stack.
    • DELETE /v2/stacks/{stackId} to delete a Stack.
  • A new optional request parameter state has been added to the GET /v2/contributors/{contributorId}/webhook-executions operation.
  • The optional property isEmployee has been added to user objects in conversation member and message responses.
  • A new optional request property description has been added to the PATCH /v2/stacks/{stackId} operation.

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

Detailed changes​

Changes in "Get all conversations the authenticated user has created or has access to"​

The response schema has been restructured: all conversation fields are now defined in the BasicConversation schema and composed into the response via allOf. This is a spec-level reorganization — the response payload is identical for API consumers. All previously required and optional fields (conversationId, createdAt, mainUser, shortId, status, title, visibility, category, createdBy, lastMessage, lastMessageAt, lastMessageBy, notificationRoles, relatedTo, relations, sharedWith) remain available via BasicConversation.

  • (spec reorganization only): the /items/ response type changed from object to allOf[BasicConversation] for status 200 — response payload is unchanged
  • added #/components/schemas/de.mittwald.v1.conversation.BasicConversation to the /items/ response allOf list for status 200

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

Changes in "Get a support conversation"​

Same restructuring as above — all conversation fields are now defined in BasicConversation and composed via allOf. The response payload is unchanged.

  • (spec reorganization only): the response body type changed from object to allOf[BasicConversation] for status 200 — response payload is unchanged
  • added #/components/schemas/de.mittwald.v1.conversation.BasicConversation to the response body allOf list for status 200

For details, refer to the GET/v2/conversations/{conversationId}/ endpoint.

Changes in "Get members of a support conversation"​

The fields atlasGroup, department, and group have been removed. These were internal mittwald fields accidentally exposed in the spec — they were never returned to external API users. Their removal corrects the spec to match actual behavior.

  • removed the optional property /items/allOf[de.mittwald.v1.conversation.User]/atlasGroup from the response with status 200
  • removed the optional property /items/allOf[de.mittwald.v1.conversation.User]/department from the response with status 200
  • removed the optional property /items/allOf[de.mittwald.v1.conversation.User]/group from the response with status 200
  • added the optional property /items/allOf[de.mittwald.v1.conversation.User]/isEmployee to the response with status 200

For details, refer to the GET/v2/conversations/{conversationId}/members/ endpoint.

Changes in "Get all messages of the conversation"​

Same cleanup as above — atlasGroup, department, and group were internal fields never returned to external users. Additionally, isEmployee is now officially documented.

  • removed the optional property createdBy/atlasGroup from Message items
  • removed the optional property createdBy/department from Message items
  • removed the optional property createdBy/group from Message items
  • removed the optional property meta/user/atlasGroup from GenericStatusUpdate and ResubmissionStatusUpdate items
  • removed the optional property meta/user/department from GenericStatusUpdate and ResubmissionStatusUpdate items
  • removed the optional property meta/user/group from GenericStatusUpdate and ResubmissionStatusUpdate items
  • added the optional property createdBy/isEmployee to Message items
  • added the optional property meta/user/isEmployee to GenericStatusUpdate and ResubmissionStatusUpdate items

For details, refer to the GET/v2/conversations/{conversationId}/messages/ endpoint.

Removed schemas​

  • removed the schema de.mittwald.v1.conversation.Department
  • removed the schema de.mittwald.v1.conversation.Group

These schemas were never part of the public API surface and only appeared internally in the spec.

Changes in "List Container Templates"​

  • endpoint added

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

Changes in "Get a Container Template by ID"​

  • endpoint added

For details, refer to the GET/v2/container-templates/{templateId}/ endpoint.

Changes in "List all Webhook Executions"​

  • added the new optional query request parameter state

For details, refer to the GET/v2/contributors/{contributorId}/webhook-executions/ endpoint.

Changes in "List Projects belonging to a Customer"​

  • endpoint added

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

Changes in "List Domain-Migrations belonging to a Project"​

  • endpoint added

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

Changes in "Create a Stack"​

  • endpoint added

For details, refer to the POST/v2/projects/{projectId}/stacks/ endpoint.

Changes in "Delete a Stack"​

  • endpoint added

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

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

  • added the new optional request property description

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

Client package releases​

mittwald JavaScript SDK Release 4.398.0​

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

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

mittwald JavaScript SDK Release 4.396.0​

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

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

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

  • Updated the generated client, enhancing the SDK's functionality and performance. For more details, refer to the commit c22f2e8.

For further information and to view the release notes, visit the release page.

mittwald JavaScript SDK Release 4.393.0​

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

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

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

mittwald JavaScript SDK Release 4.390.0​

The mittwald JavaScript SDK has been updated to version 4.390.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/api-client-js 4.390.0.

mittwald JavaScript SDK Release 4.389.0​

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