Zum Hauptinhalt springen

API changes for v2 API, August 7 to August 14

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

This week, the mittwald API introduces several enhancements, including the addition of the 'runtimeApps' enum value to various response properties, the introduction of a new endpoint for retrieving container template assets, and the inclusion of required properties in responses for file creation and metadata retrieval.

Summary​

  • The new runtimeApps enum value has been added to the /items/features/items/ and /items/supportedFeatures/items/ response properties for the response status '200' in the GET /v2/customers/{customerId}/projects operation.
  • The new runtimeApps enum value has also been added to the /items/features/items/ and /items/supportedFeatures/items/ response properties for the response status '200' in the GET /v2/projects operation.
  • Additionally, the runtimeApps enum value has been added to the features/items/ and supportedFeatures/items/ response properties for the response status '200' in the GET /v2/projects/{projectId} operation.
  • An endpoint has been added for the operation GET /v2/container-templates/{templateId}/assets/{assetPath}, which retrieves a Container Template asset.
  • A non-success response with the status '304' has been added to the GET /v2/container-templates/{templateId}/icon operation, which retrieves a Container Template icon.
  • The required property shortId has been added to the response with the '201' status in the POST /v2/files operation, which creates a file.
  • The required property shortId has also been added to the response with the '200' status in the GET /v2/files/{fileId}/meta operation, which retrieves a file's metadata.

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

Detailed changes​

Changes in "List Projects belonging to a Customer"​

  • added the new 'runtimeApps' enum value to the '/items/features/items/' response property for the response status '200'

  • added the new 'runtimeApps' enum value to the '/items/supportedFeatures/items/' response property for the response status '200'

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

Changes in "List Projects belonging to the executing user"​

  • added the new 'runtimeApps' enum value to the '/items/features/items/' response property for the response status '200'

  • added the new 'runtimeApps' enum value to the '/items/supportedFeatures/items/' response property for the response status '200'

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

Changes in "Get a Project"​

  • added the new 'runtimeApps' enum value to the 'features/items/' response property for the response status '200'

  • added the new 'runtimeApps' enum value to the 'supportedFeatures/items/' response property for the response status '200'

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

Changes in "Get a Container Template asset"​

  • endpoint added

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

Changes in "Get a Container Template icon"​

  • added the non-success response with the status '304'

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

Changes in "Create a File"​

  • added the required property 'shortId' to the response with the '201' status

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

Changes in "Get a File's meta"​

  • added the required property 'shortId' to the response with the '200' status

For details, refer to the GET/v2/files/{fileId}/meta/ endpoint.

Client package releases​

Release Summary: mittwald PHP SDK v2.1.215​

The mittwald PHP SDK has been updated to version v2.1.215. This release introduces a new endpoint for retrieving container template assets, enhancing the flexibility of cloud resource management. The new endpoint allows users to request specific assets within a given template.

  • New Endpoint: /v2/container-templates/{templateId}/assets/{assetPath}
  • Method: GET
  • New Class: GetTemplateAssetRequest
  • Response Classes:
    • GetTemplateAssetBadRequestResponse
    • GetTemplateAssetForbiddenResponse
    • GetTemplateAssetNotFoundResponse
    • GetTemplateAssetDefaultResponse
    • GetTemplateAssetInternalServerErrorResponse
    • GetTemplateAssetServiceUnavailableResponse
    • GetTemplateAssetTooManyRequestsResponse

Additionally, the FileMeta class has been updated to include a new shortId property, providing a shorter identifier for files. The constructor for FileMeta has been updated to support this new parameter.

For more details, visit the release page.

mittwald JavaScript SDK Release 4.441.0​

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

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

mittwald JavaScript SDK Release 4.439.0​

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