Migration Guide

v0.11.x -> v0.12.x

Version 0.12.0 introduces a breaking change by generating tapir v1.0 compatible code, which is not source-compatible with tapir v0.19+. As such, it is recommended to fully regenerate all scraml generated Scala code after updating the tapir library dependencies in sbt build files to at least 1.0.5.

v0.10.x -> v0.11.x

Version 0.11.0 introduces a breaking change when additionalProperties support is enabled. A second constructor argument list is added to these types which did not exist in 0.10.x and below.

The Default policy is to emit code which adheres closely to the RAML Additional Properties specification.

See Setup

Note

Use the scraml.FieldMatchPolicy.Exact policy to produce generated code which behaves similarly to 0.10.x.

The source code for this page can be found here.