API Changes

This page centralizes API contract changes for integrators.

Changelog

Version 6.1.0

Added

  • OpenAPI Expanded operation-level documentation for webservice controllers (Auth, Import, Export, HealthCheck).
  • OpenAPI Stable operationId values on key endpoints.
  • OpenAPI Richer DTO property descriptions in generated OpenAPI schemas.
  • Usage Documentation The documentation you are reading

Changed

  • Breaking Change API Call Error response contracts standardized to ProblemDetails for documented 400/401/404 webservice responses.
  • Breaking Change EpdFullDataDto and EpdShortDataDto now containe archiving date for archived products
  • Breaking Change GET /ws/Epd lastUpdateDate now reflects the archiving date for archived products instead of the last update date if greater.
  • OpenAPI POST /ws/Epd success response documentation aligned with full EPD payload (EpdFullDataDto).
  • OpenAPI API Call Binary download endpoint documentation refined to advertise binary content for success responses only.
  • OpenAPI Swagger schema naming keeps full namespace uniqueness while using readable aliases for:
    • ProblemDetails
    • ValidationProblemDetails

Fixed

  • OpenAPI Nullability and XML documentation issues in updated webservice controllers and DTO surfaces.