tapir

What’s Changed

• Return HTTP 405 when an endpoint matches path but not method (#1356) @dvgica
• Add SwaggerZioHttp (#1369) @slabiakt
• Added filtering of implicit headers for Play (#1375) @bartekzylinski

Dependency updates

• Update model:core to 1.4.9 (#1376) @scala-steward

What’s Changed

• Migrate to cats-effect 3 & http4s 0.23 (#1154) @adamw
• Update client3:akka-http-backend, ... to 3.3.11 (#1373) @scala-steward
• Enable more http4s modules for scala 3 (#1371) @amumurst
• schema derivation cannot be checked at runtime (#1372) @mbore

Summary

The main features in this release:

• Scala3 support: core, http4s & vertx servers, sttp client, as well as some json and datatypes integrations are available in the JVM flavor
• content negotiation on server & client side
• the structure of data is reflected only in schemas, not in validators. Validators are much simpler now, and part of schemas
• server interpreters have been rewritten, and support two types of interceptors (request & endpoint interceptors). Some functionalities (logging, decode failure handling) are implemented as interceptors; custom interceptors can be added
• exceptions are handled and result in the 500 status code
• The generated documentation will now include an entry for 400 Bad Request by default, if none is specified by the user, enumerating the reasons on why request decoding might fail. This can be turned off or adjusted in OpenAPIDocsOptions.
• ZIO Http server interpreter

Thanks to all the contributors for their cooperation, especially @mbore, @kubinio123, @bartekzylinski, @slabiakt, @danielleontiev, @hamnis, @majk-p, @MichalPawlicki, @PawelJ-PL, @endertunc, @ae0n!

Major breaking changes

• SchemaTypes are not objects, but classes. If you specified the schema type manually, instead of e.g. SchemaType.SString you'll have to use SchemaType.SString()
• server options have been significantly refactored. To create custom options, use e.g. AkkaServerOptions.customInterceptors
• Validator.enum method has been renamed to Validator.enumeration, and .derivedEnum to .derivedEnumeration, as enum is now a keyword in Scala3
• due to changes to companion objects in Scala3, .mapTo(Companion) is replaced with a macro: .mapTo[CaseClass]
• akka server interpreter: removal of .toDirective
• annotations have been moved; endpoint annotations to EndpointIO.annotations, and schema annotations to Schema.annotations. Instead of derivedEndpointInput, used EndpointInput.derived instead
• options for interpreters are now passed as explicit parameters to the interpreters, not as implicit ones to individual methods. If no options are provided, default parameters are used. If you've used default parameters, you'll need to add () to the interpreter, as it is now a class, not an object. E.g. AkkaHttpServerInterpreter.toRoutes(endpoints) becomes:

AkkaHttpServerInterpreter().toRoutes(endpoints)

If you have custom options, you'll need to change code such as:

implicit val options = AkkaHttpServerOptions.customInterceptors(...)
AkkaHttpServerInterpreter.toRoutes(endpoints)

into:

val options = AkkaHttpServerOptions.customInterceptors(...)
AkkaHttpServerInterpreter(options).toRoutes(endpoints)

Other breaking changes

• rewritten SchemaType.[SProduct|SCoproduct|SOpenProduct]
• DecodeFailureHandler - minor changes in method signatures, the default one is now DefaultDecodeFailureHandler.handler
• LogRequestHandling -> ServerLog
• Codec is no longer a Mapping
• play server interpreter: toRoute -> toRoutes
• deprecated statusMapping in favor of oneOfMapping
• enumerations in openapi model (parameters, parameter style) are now sealed trait families
• schema improvements: SObjectInfo is replaced by SName; coproducts are more general, as they can include any child schemas (not only objects)
• enums are referenced by default, there's no referenceEnums option in the documentation interpreters. To inline enums, you'll need to define the enum validator without a name, or remove the name from the derived schema.

What’s Changed since v0.18.0-M18

• Change backend client for awsLambda (#1365) @bartekzylinski
• Zhttp (#1337) @bartekzylinski
• Fixed Validator methods names (#1362) @gruggiero
• Annotations cleanup: scoping, schema annotations support (#1351) @adamw
• Move methods to derive endpoint inputs/outputs to companion objects, rename the methods to derived (#1348) @adamw

Dependency updates since v0.18.0-M18

• Update scala3-library to 3.0.1 (#1366) @scala-steward
• Update swagger-ui to 3.51.1 (#1363) @scala-steward
• Update vertx-web to 4.1.1 (#1353) @scala-steward
• Update client3:akka-http-backend, ... to 3.3.9 (#1352) @scala-steward
• Update jsoniter-scala-core, ... to 2.9.1 (#1350) @scala-steward
• Update jawn-parser to 1.2.0 (#1364) @scala-steward
• Update magnolia-core to 2.0.0-M9 (#1358) @scala-steward
• Update swagger-ui to 3.51.0 (#1355) @scala-steward
• Update derevo-core to 0.12.6 (#1346) @scala-steward

What’s Changed

• circe updated to 0.14.1

Breaking changes

• options for interpreters are now passed as explicit parameters to the interpreters, not as implicit ones to individual methods. If no options are provided, default parameters are used. If you've used default parameters, you'll need to add () to the interpreter, as it is now a class, not an object. E.g. AkkaHttpServerInterpreter.toRoutes(endpoints) becomes:

AkkaHttpServerInterpreter().toRoutes(endpoints)

If you have custom options, you'll need to change code such as:

implicit val options = AkkaHttpServerOptions.customInterceptors(...)
AkkaHttpServerInterpreter.toRoutes(endpoints)

into:

val options = AkkaHttpServerOptions.customInterceptors(...)
AkkaHttpServerInterpreter(options).toRoutes(endpoints)

• schema improvements: SObjectInfo is replaced by SName; coproducts are more general, as they can include any child schemas (not only objects)
• enums are referenced by default, there's no referenceEnums option in the documentation interpreters. To inline enums, you'll need to define the enum validator without a name, or remove the name from the derived schema.

What’s Changed

• Update json4s-core, json4s-jackson to 4.0.1 (#1344) @scala-steward
• Update magnolia-core to 1.0.0-M4 (#1343) @scala-steward
• Update jsoniter-scala-core, ... to 2.9.0 (#1340) @scala-steward
• fixed docs generation of referenced enums when they're inside of a collection (#1341) @ae0n
• Fix instanceFromValues for case class with defined companion object (#1345) @mbore
• Named schemas (#1339) @adamw
• Missing components for AsyncAPI (#1338) @mbore
• Make authorizationUrl optional (#1342) @dvgica
• Setting options for AkkaHttpServerInterpreter as explicit parameter (#1321) @bartekzylinski
• Update scala3-library to 3.0.1-RC2 (#1334) @scala-steward
• Add test case for status code mappings with empty output with descrip… (#1332) @slabiakt
• Update enumeratum to 1.7.0 (#1331) @scala-steward
• Update client3:akka-http-backend, ... to 3.3.7 (#1330) @scala-steward

New features

Some of the modules are now available for Scala3 on the JVM: core, http4s & vertx servers, sttp client, as well as some json and datatypes integrations

Breaking changes

• Validator.enum method has been renamed to Validator.enumeration, and .derivedEnum to .derivedEnumeration, as enum is now a keyword in Scala3
• due to changes to companion objects in Scala3, .mapTo(Companion) is replaced with a macro: .mapTo[CaseClass]
• enumerations in openapi model (parameters, parameter style) are now sealed trait families

What’s Changed

• #1317 fix http4s swagger contextPath for multi path part (#1318) @stsatlantis
• fixed referencing enums for optional fields (#1327) @ae0n
• Use URLEncoder.encode() for paths rendering (#1325) @slabiakt
• Add Shadowed Endpoints Checker functionality (#1301) @slabiakt
• Update scala-logging to 3.9.4 (#1322) @scala-steward
• Update scalacheck-toolbox-datetime to 0.6.0 (#1320) @scala-steward
• Enable more projects for scala3 (#1315) @adamw
• Update magnolia-core to 2.0.0-M8 (#1316) @scala-steward
• Scala3 (#1204) @adamw
• Update OpenapiCodegenTask.scala (#1312) @kastoestoramadus
• Update sbt-scalajs, scalajs-library, ... to 1.6.0 (#1299) @scala-steward
• fix(http4s-client): exclude empty query params from URI (#1308) @MichalPawlicki
• Use proper types in openapi docs for example and enum values (#1311) @adamw
• fix core tests (#1310) @mbore
• Adapt oneOfUsingField (#1309) @mbore
• Update akka-stream to 2.6.15 (#1307) @scala-steward
• Schema derivation configuration (#1304) @mbore
• Update opentelemetry-api, ... to 1.3.0 (#1305) @scala-steward
• adapt MatchType macro (#1287) @mbore
• Add fix for explicit content-type header priority issue (#1297) @slabiakt
• Update upickle to 1.4.0 (#1298) @scala-steward
• Update swagger-ui to 3.50.0 (#1294) @scala-steward
• Update sbt-assembly to 1.0.0 (#1296) @scala-steward
• fix: 🐛 #1272 Allow exposing Swagger on a non-root route (#1295) @gaeljw

What’s Changed

• Update zio, zio-streams, zio-test, ... to 1.0.9 (#1290) @scala-steward
• Update client3:akka-http-backend, ... to 3.3.6 (#1291) @scala-steward
• Update aws-lambda-java-runtime-interface-client to 1.1.0 (#1292) @scala-steward
• Revert "Update catbird-effect, catbird-finagle to 21.5.0" (#1293) @adamw
• Update catbird-effect, catbird-finagle to 21.5.0 (#1289) @scala-steward
• Update jawn-parser to 1.1.2 (#1286) @scala-steward
• Update circe-yaml to 0.14.0 (#1285) @scala-steward
• Update vertx-web to 4.1.0 (#1288) @scala-steward
• Update jawn-parser to 1.0.3 (#1284) @scala-steward
• Update refined to 0.9.26 (#1273) @scala-steward
• Update http4s-blaze-client, ... to 0.21.24 (#1275) @scala-steward
• Update circe-core, circe-generic, ... to 0.14.1 (#1274) @scala-steward
• Fixes oneOf with empty body openapi spec generation (#1281) @Paulymorph
• Update scala-compiler, scala-library, ... to 2.12.14 (#1279) @scala-steward
• Update tethys-core, tethys-derivation, ... to 0.24.0 (#1277) @scala-steward
• Tapir aws (#1226) @kubinio123
• Update simpleclient_common to 0.11.0 (#1282) @scala-steward
• Update vertx-web to 4.1.0.CR2 (#1278) @scala-steward
• Update zio-interop-cats to 3.1.1.0 (#1269) @scala-steward
• Update sbt-mima-plugin to 0.9.2 (#1268) @scala-steward
• Update jsoniter-scala-core, ... to 2.8.2 (#1258) @scala-steward
• Update zio-interop-cats to 2.5.1.0 (#1259) @scala-steward
• Update json4s-core, json4s-jackson to 4.0.0 (#1267) @scala-steward
• Update client3:akka-http-backend, ... to 3.3.5 (#1266) @scala-steward
• Update vertx-web to 4.1.0.CR1 (#1262) @scala-steward
• Update swagger-ui to 3.49.0 (#1261) @scala-steward
• Update zio-json to 0.1.5 (#1260) @scala-steward
• Openapi convenience (#1230) @hamnis
• Update shared:akka, shared:core, ... to 1.2.5 (#1252) @scala-steward
• Update upickle to 1.3.15 (#1251) @scala-steward
• Use early-semver versioning scheme, add MiMa and sbt-dynver (#1129) @majk-p
• Update zio, zio-streams, zio-test, ... to 1.0.8 (#1250) @scala-steward
• Update cats-effect to 2.5.1 (#1233) @scala-steward
• Update mdoc, sbt-mdoc to 2.2.21 (#1234) @scala-steward
• Update scalatest to 3.2.9 (#1238) @scala-steward
• Update client3:akka-http-backend, ... to 3.3.3 (#1240) @scala-steward
• Update discipline-scalatest to 2.1.5 (#1243) @scala-steward
• Update upickle to 1.3.14 (#1245) @scala-steward
• Revert "Upgrade to OpenAPI 3.1.0" (#1247) @adamw
• Upgrade to OpenAPI 3.1.0 (#1223) @rojekp
• Update http4s-blaze-client, ... to 0.21.23 (#1246) @scala-steward
• Update scala-java-time, ... to 2.3.0 (#1244) @scala-steward
• Update model:core to 1.4.7 (#1241) @scala-steward
• Update upickle to 1.3.13 (#1236) @scala-steward
• Update shared:akka, shared:core, ... to 1.2.4 (#1237) @scala-steward
• Update refined to 0.9.25 (#1235) @scala-steward
• Update cats-core, cats-laws to 2.6.1 (#1232) @scala-steward
• Update sbt-mima-plugin to 0.9.1 (#1231) @scala-steward
• Update client3:akka-http-backend, ... to 3.3.2 (#1229) @scala-steward
• Update model:core to 1.4.6 (#1215) @scala-steward
• Update client3:akka-http-backend, ... to 3.3.1 (#1221) @scala-steward
• Update jsoniter-scala-core, ... to 2.8.1 (#1224) @scala-steward
• Update opentelemetry-api, ... to 1.2.0 (#1222) @scala-steward

What’s Changed

• Openapi convenience (#1230) @hamnis
• Update shared:akka, shared:core, ... to 1.2.5 (#1252) @scala-steward
• Update upickle to 1.3.15 (#1251) @scala-steward
• Use early-semver versioning scheme, add MiMa and sbt-dynver (#1129) @majk-p
• Update zio, zio-streams, zio-test, ... to 1.0.8 (#1250) @scala-steward
• Update cats-effect to 2.5.1 (#1233) @scala-steward
• Update mdoc, sbt-mdoc to 2.2.21 (#1234) @scala-steward
• Update scalatest to 3.2.9 (#1238) @scala-steward
• Update client3:akka-http-backend, ... to 3.3.3 (#1240) @scala-steward
• Update discipline-scalatest to 2.1.5 (#1243) @scala-steward
• Update upickle to 1.3.14 (#1245) @scala-steward
• Revert "Upgrade to OpenAPI 3.1.0" (#1247) @adamw
• Upgrade to OpenAPI 3.1.0 (#1223) @rojekp
• Update http4s-blaze-client, ... to 0.21.23 (#1246) @scala-steward
• Update scala-java-time, ... to 2.3.0 (#1244) @scala-steward
• Update model:core to 1.4.7 (#1241) @scala-steward
• Update upickle to 1.3.13 (#1236) @scala-steward
• Update shared:akka, shared:core, ... to 1.2.4 (#1237) @scala-steward
• Update refined to 0.9.25 (#1235) @scala-steward
• Update cats-core, cats-laws to 2.6.1 (#1232) @scala-steward
• Update sbt-mima-plugin to 0.9.1 (#1231) @scala-steward
• Update client3:akka-http-backend, ... to 3.3.2 (#1229) @scala-steward
• Update model:core to 1.4.6 (#1215) @scala-steward
• Update client3:akka-http-backend, ... to 3.3.1 (#1221) @scala-steward
• Update jsoniter-scala-core, ... to 2.8.1 (#1224) @scala-steward
• Update opentelemetry-api, ... to 1.2.0 (#1222) @scala-steward
• feat(openapi): provide default 400 responses in docs (#1153) @MichalPawlicki
• Update jsoniter-scala-core, ... to 2.8.0 (#1219) @scala-steward
• Update sbt-mima-plugin to 0.9.0 (#1217) @scala-steward
• Fix test issue #1169 (#1214) @danilbykov

Breaking changes

The generated documentation will now include an entry for 400 Bad Request by default, if none is specified by the user, enumerating the reasons on why request decoding might fail. This can be turned off od adjusted in OpenAPIDocsOptions.

What’s Changed

• feat(openapi): provide default 400 responses in docs (#1153) @MichalPawlicki
• Update jsoniter-scala-core, ... to 2.8.0 (#1219) @scala-steward
• Update sbt-mima-plugin to 0.9.0 (#1217) @scala-steward
• Fix test issue #1169 (#1214) @danilbykov

What’s Changed

• opentelemetry default metrics (#1209) @kubinio123
• [#1032] Added mock server integration (#1097) @vitaliihonta
• Update scalacheck to 1.15.4 (#1213) @scala-steward
• Update swagger-ui to 3.48.0 (#1210) @scala-steward

What’s Changed

• TapirFile instead of SttpFile (#1208) @kubinio123
• add zio-json support (#1197) @endertunc
• observability for endpoints (#1151) @kubinio123
• Update jsoniter-scala-core, ... to 2.7.3 (#1207) @scala-steward
• Update derevo-core to 0.12.5 (#1206) @scala-steward
• Update upickle to 1.3.12 (#1205) @scala-steward
• Update client3:akka-http-backend, ... to 3.3.0 (#1202) @scala-steward
• Update model:core to 1.4.5 (#1201) @scala-steward
• Update discipline-scalatest to 2.1.4 (#1200) @scala-steward
• Asyncapi extensions (#1189) @danielleontiev
• Fix ZIO issues (#1195) @PawelJ-PL
• stub server endpoint (#1193) @kubinio123
• Update client3:akka-http-backend, ... to 3.3.0-RC5 (#1194) @scala-steward
• Raw value tmp files (#1182) @kubinio123
• Update model:core to 1.4.4 (#1188) @scala-steward
• Update zio-interop-cats to 2.4.1.0 (#1184) @scala-steward
• Update cats-core, cats-laws to 2.6.0 (#1179) @scala-steward
• Update shared:akka, shared:core, ... to 1.2.2 (#1178) @scala-steward
• Update swagger-ui to 3.47.1 (#1177) @scala-steward
• Update zio, zio-streams to 1.0.7 (#1191) @scala-steward
• Update scala-java-time, ... to 2.2.2 (#1190) @scala-steward
• Update refined to 0.9.24 (#1187) @scala-steward
• Update scalatest to 3.2.8 (#1185) @scala-steward
• Update client3:akka-http-backend, ... to 3.3.0-RC4 (#1183) @scala-steward
• Update mdoc, sbt-mdoc to 2.2.20 (#1181) @scala-steward
• Update cats-effect to 2.5.0 (#1180) @scala-steward
• Update jsoniter-scala-core, ... to 2.7.2 (#1176) @scala-steward

What’s Changed

• Openapi extensions (#1166) @danielleontiev
• Update model:core to 1.4.3 (#1174) @scala-steward
• Update shared:akka, shared:core, ... to 1.2.1 (#1175) @scala-steward
• Update client3:akka-http-backend, ... to 3.3.0-RC3 (#1173) @scala-steward
• Update derevo-core to 0.12.3 (#1172) @scala-steward
• Update model:core to 1.4.2 (#1171) @scala-steward

What’s Changed

• Change the shape of interceptors, introduce EndpointHandler and RequestHandler (#1165) @adamw
• Update refined to 0.9.23 (#1134) @scala-steward
• Issue/1081 (#1100) @kubinio123
• Update client3:akka-http-backend, ... to 3.3.0-RC2 (#1163) @scala-steward
• ZTapir as a trait (#1162) @adamw
• Fix some JSON doc (#1155) @longshorej
• Update zio, zio-streams to 1.0.6 (#1160) @scala-steward
• Enable finatra server interpreter for Scala 2.13 (#1152) @adamw
• Update akka-stream to 2.6.14 (#1146) @scala-steward
• Update model:core to 1.4.1 (#1144) @scala-steward

What’s Changed

• Run JS tests in one go (#1142) @adamw
• Update http4s-blaze-server, http4s-circe, ... to 0.21.22 (#1143) @scala-steward
• Add newtype support for scala.js (#1135) @mprevel
• Expanded doc for Scala.JS sttp client (#1141) @mcallisto
• Update scala-java-time, ... to 2.2.1 (#1137) @scala-steward
• Update jsoniter-scala-core, ... to 2.7.1 (#1136) @scala-steward
• Correct typo (#1133) @mcallisto

What’s Changed

• Helper methods to validate options/iterables (#1131) @adamw
• Update client3:akka-http-backend, ... to 3.2.3 (#1130) @scala-steward
• Enum as component (#1121) @kubinio123
• Update upickle to 1.3.11 (#1128) @scala-steward
• Update discipline-scalatest to 2.1.3 (#1127) @scala-steward
• Nicer partial endpoint types (#1126) @adamw
• Update scalatest to 3.2.7 (#1125) @scala-steward
• Update sbt-scalajs, scalajs-compiler, ... to 1.5.1 (#1123) @scala-steward
• Update swagger-ui to 3.46.0 (#1124) @scala-steward

Summary

The main features in this release:

• content negotiation support on server & client side
• data structure is reflected only in schemas, not in validators. Validators are much simpler now
• server interpreters are rewritten, and support two types of interceptors (request & endpoint interceptors). Some functionalities (logging, decode failure handling) are implemented as interceptors
• exceptions are handled and result in the 500 status code

Breaking changes

• DecodeFailureHandler - minor changes in method signatures, the default one is now DefaultDecodeFailureHandler.handler
• LogRequestHandling -> ServerLog
• server options have been significantly refactored. To create custom options, use e.g. AkkaServerOptions.customInterceptors
• there's no single streamBody method, instead there are streamBinaryBody, streamTextBody, streamListBody, streamIterableBody
• SchemaTypes are not objects, but classes. If you specified the schema type manually, instead of e.g. SchemaType.SString you'll have to use SchemaType.SString()
• rewritten SchemaType.[SProduct|SCoproduct|SOpenProduct]
• Codec is no longer a Mapping
• Validator.enum -> Validator.derivedEnum
• akka server interpreter: removal of .toDirective
• play server interpreter: toRoute -> toRoutes
• deprecated statusMapping in favor of oneOfMapping

What’s Changed

• Rename statusMapping to oneOfMapping, docs (#1120) @adamw
• Implement request interceptors (#1118) @adamw
• Interceptors content negotiation (#1078) @kubinio123
• Add exception interceptors (#1109) @adamw
• [Minor] Add convenience method for empty outputs (#1106) @Qthunder
• feature: implement http4s client interpreter (#1080) @MichalPawlicki
• Move validation logic to schemas. Only schemas have structure, not validators (#1105) @adamw
• Yaml test cleanup (#1101) @kubinio123
• Implements #1065: Interceptors (#1089) @adamw
• Update derevo integration; (#1086) @FunFunFine

Dependency updates

• Update refined to 0.9.22 (#1114) @scala-steward
• Update cats-core, cats-laws to 2.5.0 (#1115) @scala-steward
• Update cats-effect to 2.4.1 (#1116) @scala-steward
• Update zio-interop-cats to 2.4.0.0 (#1112) @scala-steward
• Update mdoc_2.12, sbt-mdoc to 2.2.19 (#1113) @scala-steward
• Update http4s-blaze-server, http4s-circe, ... to 0.21.21 (#1110) @scala-steward
• Update cats-effect to 2.4.0 (#1095) @scala-steward
• Update jsoniter-scala-core, ... to 2.7.0 (#1108) @scala-steward
• Update upickle to 1.3.9 (#1103) @scala-steward
• Update client3:akka-http-backend, ... to 3.2.0 (#1102) @scala-steward
• Update scala-logging to 3.9.3 (#1098) @scala-steward
• Update upickle to 1.3.8 (#1094) @scala-steward
• Update sbt-twirl to 1.5.1 (#1093) @scala-steward
• Update derevo-core to 0.12.2 (#1092) @scala-steward
• Update tagging to 2.3.0 (#1090) @scala-steward
• Update play-ahc-ws-standalone to 2.1.3 (#1091) @scala-steward
• Update upickle to 1.3.7 (#1088) @scala-steward
• Update client3:akka-http-backend, ... to 3.1.9 (#1087) @scala-steward
• Update upickle to 1.3.4 (#1085) @scala-steward

What’s Changed

• Use correct validators when generating schema. Simplify schema generation. (#1084) @kubinio123

What’s Changed

• Docs for SSE (#1083) @wojciechUrbanski
• Update vertx-web to 4.0.3 (#1077) @scala-steward
• Update swagger-ui to 3.45.0 (#1075) @scala-steward
• Support SSE for Akka HTTP and http4s (#1079) @wojciechUrbanski

What’s Changed

• Add Transfer-Encoding header while streaming data and using HTTP4s (#1073) @wojciechUrbanski
• Update zio, zio-streams to 1.0.5 (#1071) @scala-steward
• Update upickle to 1.3.0 (#1068) @scala-steward

What’s Changed

• Fix requestBody decoder for sbt-openapi-codegen (#1063) @mhertogs
• fix(server): URL-decode captured path segments (#1062) @MichalPawlicki
• Update scalatest to 3.2.6 (#1067) @scala-steward
• Add schema for uuid (#1060) @matwojcik
• fixed Play JSON error message when input is not a valid JSON document (#1061) @markarasev
• Schema not found - improvements (#1059) @majk-p