Zum Hauptinhalt springen

Breaking (!) API changes for v2 API, July 29, 2024

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

This document contains a machine-generated summary of the API changes for July 29, 2024. The API changes are based on the diff between the OpenAPI schemas of the two versions.

Summary​

  • A 429 Too Many Requests status code has been added to the specification of every API endpoint. This status code is returned when the rate limit is exceeded. The rate limiting feature is not new, but the documentation has been updated to reflect this behavior. See the section on API ratelimiting for more information.
  • Changed the way the request body of the PATCH/v2/ingresses/{ingressId}/tls/ endpoint is defined (might potentially cause breaking changes in generated client code).

Detailed changes​

Changes in "Update the tls settings of an Ingress"​

  • ⚠️ Breaking: replaced '#/components/schemas/de.mittwald.v1.ingress.TlsAcme, #/components/schemas/de.mittwald.v1.ingress.TlsCertificate' from the request body 'oneOf' list, and substituted inline schemas. Note that this is not a breaking change when you are using the API directly, but it might cause breaking changes in code generated from the OpenAPI schema.

For details, refer to the PATCH/v2/ingresses/{ingressId}/tls/ endpoint.

Changes to all API endpoints​

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

Changes in "Create an Order"​

  • removed the non-success response with the status '403'

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

Changes in "Register with email and password"​

  • removed the non-success response with the status '403'

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

Changes in "Resend the mail address verification email"​

  • removed the non-success response with the status '403'

For details, refer to the POST/v2/signup/email/resend/ endpoint.

Changes in "Initialize password reset process"​

  • removed the non-success response with the status '403'

For details, refer to the POST/v2/signup/password/reset/ endpoint.

Changes in "Initialize password reset process"​

  • removed the non-success response with the status '403'

For details, refer to the POST/v2/users/self/credentials/actions/init-password-reset/ endpoint.

Client package releases​

mittwald PHP SDK release release v2.1.42​

The mittwald PHP SDK v2.1.42 has been released, which reflects the changes in the API. You can find the release notes here.

mittwald Javascript SDK release v4.42.0​

The mittwald JavaScript SDK v4.42.0 has been released, which reflects the changes in the API. You can find the release notes here.