Breaking (!) API changes for v2 API, May 16 to May 23

This week, the mittwald API introduces several changes including the removal and addition of default values for request parameters, updates to parameter types, the introduction of new optional parameters, and the addition of a new endpoint for listing scopes.

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

• For the GET /v2/extension-instances operation, the default values for the query request parameters limit (previously '1000.00') and page (previously '1.00') have been removed. Additionally, the type of the contextId parameter has changed from 'string'/'uuid' to 'string'/''. Note that these changes are breaking changes.
• For the GET /v2/projects/{projectId}/registries operation, the default values for the query request parameters limit (set to '1000.00') and skip (set to '0.00') have been added.
• The minimum values for the query request parameters limit (set to '1.00') and page (set to '1.00') have been set for the GET /v2/extension-instances operation.
• The minimum value for the query request parameter limit (set to '1.00') has also been set for the GET /v2/projects/{projectId}/registries operation.
• The PATCH /v2/contributors/{contributorId}/extensions/{extensionId} operation has a new optional request property assets added.
• The GET /v2/extension-instances operation has new optional query request parameters extensionId, order, sort, and page added. The context and contextId parameters have also become optional.
• The GET /v2/projects/{projectId}/registries operation has a new optional query request parameter page added.
• The GET /v2/projects/{projectId}/services operation has new optional query request parameters limit, page, and skip added.
• The GET /v2/projects/{projectId}/stacks operation has new optional query request parameters limit, page, and skip added.
• The GET /v2/projects/{projectId}/volumes operation has new optional query request parameters limit, page, and skip added.
• An endpoint GET /v2/scopes has been added to list scopes.

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

Detailed changes

Changes in "List extension instances"

• ⚠️ Breaking: for the 'query' request parameter 'limit', default value '1000.00' was removed

• ⚠️ Breaking: for the 'query' request parameter 'page', default value '1.00' was removed

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

• for the 'query' request parameter 'limit', the min was set to '1.00'

• for the 'query' request parameter 'page', the min was set to '1.00'

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

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

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

• the 'query' request parameter 'context' became optional

• the 'query' request parameter 'contextId' became optional

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

Changes in "List Registries belonging to a Project"

• ⚠️ Breaking: for the 'query' request parameter 'limit', default value '1000.00' was added

• ⚠️ Breaking: for the 'query' request parameter 'skip', default value '0.00' was added

• for the 'query' request parameter 'limit', the min was set to '1.00'

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

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

Changes in "Patch Extension"

• added the new optional request property 'assets'

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

Changes in "List Services belonging to a Project"

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

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

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

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

Changes in "List Stacks belonging to a Project"

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

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

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

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

Changes in "List Volumes belonging to a Project"

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

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

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

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

Changes in "List Scopes"

• endpoint added

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

Client package releases

mittwald JavaScript SDK Release 4.150.0

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

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

The mittwald JavaScript SDK has been updated to version 4.148.0. This release includes a feature update with an updated generated client. For more details, you can view the release on GitHub here.

mittwald JavaScript SDK Release 4.147.1

The mittwald JavaScript SDK version 4.147.1 has been released. This update includes a bug fix that addresses the escaping of special characters in the fetch-openapi-prod command. For more details, you can view the release on GitHub.

mittwald JavaScript SDK Release 4.147.0

The mittwald JavaScript SDK has been updated to version 4.147.0. This release introduces a new feature that enables experimental routes in the generated API client. For more details, you can view the release on GitHub here.

mittwald JavaScript SDK Release 4.146.0

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