feat: add support for oneOf in sttp4 client

.github/workflows/samples-scala-client.yaml

@@ -11,6 +11,7 @@ on:
       - samples/client/petstore/scala-sttp/**
       - samples/client/petstore/scala-sttp-circe/**
       - samples/client/petstore/scala-sttp4/**
+      - samples/client/petstore/scala-sttp4-circe/**
   pull_request:
     paths:
       - samples/client/petstore/scalaz/**
@@ -21,6 +22,7 @@ on:
       - samples/client/petstore/scala-sttp/**
       - samples/client/petstore/scala-sttp-circe/**
       - samples/client/petstore/scala-sttp4/**
+      - samples/client/petstore/scala-sttp4-circe/**
 jobs:
   build:
     name: Build sbt/Scala
@@ -38,6 +40,7 @@ jobs:
           - samples/client/petstore/scala-sttp
           - samples/client/petstore/scala-sttp-circe
           - samples/client/petstore/scala-sttp4
+          - samples/client/petstore/scala-sttp4-circe
     services:
       petstore-api:
         image: swaggerapi/petstore

bin/configs/scala-sttp4-circe.yaml

@@ -0,0 +1,7 @@
+generatorName: scala-sttp4
+outputDir: samples/client/petstore/scala-sttp4-circe
+inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
+templateDir: modules/openapi-generator/src/main/resources/scala-sttp4
+additionalProperties:
+  hideGenerationTimestamp: "true"
+  jsonLibrary: "circe"

docs/generators/scala-sttp4.md

@@ -20,6 +20,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 | ------ | ----------- | ------ | ------- |
 |allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
 |apiPackage|package for generated api classes| |null|
+|circeExtrasVersion|The version of circe-generic-extras library| |0.14.4|
+|circeVersion|The version of circe library| |0.14.15|
 |dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for JDK 1.8+)</dd></dl>|java8|
 |disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|true|
 |ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
@@ -36,7 +38,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
 |sourceFolder|source folder for generated code| |null|
-|sttpClientVersion|The version of sttp client| |4.0.0-M1|
+|sttpClientVersion|The version of sttp client| |4.0.15|
 
 ## IMPORT MAPPING
 

modules/openapi-generator/src/main/resources/scala-sttp4/api.mustache

@@ -20,7 +20,7 @@ class {{classname}}(baseUrl: String) {
 {{>javadoc}}
 
 {{/javadocRenderer}}
-  def {{operationId}}({{>methodParameters}}): Request[{{#separateErrorChannel}}Either[ResponseException[String, Exception], {{>operationReturnType}}]{{/separateErrorChannel}}{{^separateErrorChannel}}{{>operationReturnType}}{{/separateErrorChannel}}] =
+  def {{operationId}}({{>methodParameters}}): Request[{{#separateErrorChannel}}Either[ResponseException[String], {{>operationReturnType}}]{{/separateErrorChannel}}{{^separateErrorChannel}}{{>operationReturnType}}{{/separateErrorChannel}}] =
     basicRequest
       .method(Method.{{httpMethod.toUpperCase}}, uri"$baseUrl{{{path}}}{{#queryParams.0}}?{{/queryParams.0}}{{#queryParams}}{{baseName}}=${ {{paramName}} }{{^-last}}&{{/-last}}{{/queryParams}}{{#authMethods}}{{#isApiKey}}{{#isKeyInQuery}}{{#queryParams.0}}&{{/queryParams.0}}{{^queryParams.0}}?{{/queryParams.0}}{{keyParamName}}=${apiKeyQuery}{{/isKeyInQuery}}{{/isApiKey}}{{/authMethods}}")
       .contentType({{#consumes.0}}"{{{mediaType}}}"{{/consumes.0}}{{^consumes}}"application/json"{{/consumes}}){{#headerParams}}
@@ -31,11 +31,11 @@ class {{classname}}(baseUrl: String) {
       .cookie("{{keyParamName}}", apiKeyCookie){{/isKeyInCookie}}{{/isApiKey}}{{/authMethods}}{{#formParams.0}}{{^isMultipart}}
       .body(Map({{#formParams}}
         {{>paramFormCreation}}{{^-last}},{{/-last}}{{/formParams}}
-      )){{/isMultipart}}{{#isMultipart}}
+      ).collect { case (k, Some(v)) => k -> v }){{/isMultipart}}{{#isMultipart}}
       .multipartBody(Seq({{#formParams}}
         {{>paramMultipartCreation}}{{^-last}}, {{/-last}}{{/formParams}}
       ).flatten){{/isMultipart}}{{/formParams.0}}{{#bodyParam}}
-      .body({{paramName}}){{/bodyParam}}
+      .body(asJson({{paramName}})){{/bodyParam}}
       .response({{#separateErrorChannel}}{{^returnType}}asString.mapWithMetadata(ResponseAs.deserializeRightWithError(_ => Right(()))){{/returnType}}{{#returnType}}asJson[{{>operationReturnType}}]{{/returnType}}{{/separateErrorChannel}}{{^separateErrorChannel}}{{^returnType}}asString.mapWithMetadata(ResponseAs.deserializeRightWithError(_ => Right(()))).getRight{{/returnType}}{{#returnType}}asJson[{{>operationReturnType}}].getRight{{/returnType}}{{/separateErrorChannel}})
 
 {{/operation}}

modules/openapi-generator/src/main/resources/scala-sttp4/build.sbt.mustache

@@ -2,7 +2,7 @@ version := "{{artifactVersion}}"
 name := "{{artifactId}}"
 organization := "{{groupId}}"
 
-scalaVersion := "2.13.16"
+scalaVersion := "2.13.18"
 crossScalaVersions := Seq(scalaVersion.value, "2.12.20")
 
 libraryDependencies ++= Seq(
@@ -15,7 +15,9 @@ libraryDependencies ++= Seq(
   "org.json4s" %% "json4s-jackson" % "{{json4sVersion}}"
 {{/json4s}}
 {{#circe}}
-  "com.softwaremill.sttp.client4" %% "circe" % "{{sttpClientVersion}}"
+  "com.softwaremill.sttp.client4" %% "circe" % "{{sttpClientVersion}}",
+  "io.circe" %% "circe-generic" % "{{circeVersion}}",
+  "io.circe" %% "circe-generic-extras" % "{{circeExtrasVersion}}",
 {{/circe}}
 )
 

modules/openapi-generator/src/main/resources/scala-sttp4/jsonSupport.mustache

@@ -7,34 +7,11 @@ import {{modelPackage}}._
 {{#json4s}}
 import org.json4s._
 import sttp.client4.json4s.SttpJson4sApi
-import scala.reflect.ClassTag
 
 object JsonSupport extends SttpJson4sApi {
   def enumSerializers: Seq[Serializer[_]] = Seq[Serializer[_]](){{#models}}{{#model}}{{#isEnum}} :+
-    new EnumNameSerializer({{classname}}){{/isEnum}}{{#hasEnums}}{{#vars}}{{#isEnum}} :+
-    new EnumNameSerializer({{classname}}Enums.{{datatypeWithEnum}}){{/isEnum}}{{/vars}}{{/hasEnums}}{{/model}}{{/models}}
-
-  private class EnumNameSerializer[E <: Enumeration: ClassTag](enumeration: E) extends Serializer[E#Value] {
-    import JsonDSL._
-    val EnumerationClass: Class[E#Value] = classOf[E#Value]
-
-    def deserialize(implicit format: Formats): PartialFunction[(TypeInfo, JValue), E#Value] = {
-      case (t @ TypeInfo(EnumerationClass, _), json) if isValid(json) =>
-        json match {
-          case JString(value) => enumeration.withName(value)
-          case value => throw new MappingException(s"Can't convert $value to $EnumerationClass")
-        }
-    }
-
-    private[this] def isValid(json: JValue) = json match {
-      case JString(value) if enumeration.values.exists(_.toString == value) => true
-      case _ => false
-    }
-
-    def serialize(implicit format: Formats): PartialFunction[Any, JValue] = {
-      case i: E#Value => i.toString
-      }
-    }
+    {{classname}}.{{classname}}Serializer{{/isEnum}}{{#hasEnums}}{{#vars}}{{#isEnum}} :+
+    {{classname}}Enums.{{datatypeWithEnum}}.{{datatypeWithEnum}}Serializer{{/isEnum}}{{/vars}}{{/hasEnums}}{{/model}}{{/models}}
 
   implicit val format: Formats = DefaultFormats ++ enumSerializers ++ DateSerializers.all ++ AdditionalTypeSerializers.all
   implicit val serialization: org.json4s.Serialization = org.json4s.jackson.Serialization
@@ -43,17 +20,9 @@ object JsonSupport extends SttpJson4sApi {
 {{#circe}}
 import io.circe.{Decoder, Encoder}
 import io.circe.generic.AutoDerivation
-import sttp.client3.circe.SttpCirceApi
+import sttp.client4.circe.SttpCirceApi
 
 object JsonSupport extends SttpCirceApi with AutoDerivation with DateSerializers with AdditionalTypeSerializers {
-
-{{#models}}
-{{#model}}
-{{#isEnum}}
-  implicit val {{classname}}Decoder: Decoder[{{classname}}.{{classname}}] = Decoder.decodeEnumeration({{classname}})
-  implicit val {{classname}}Encoder: Encoder[{{classname}}.{{classname}}] = Encoder.encodeEnumeration({{classname}})
-{{/isEnum}}
-{{/model}}
-{{/models}}
+  // Enum encoders/decoders are defined in their respective companion objects
 }
 {{/circe}}

modules/openapi-generator/src/main/resources/scala-sttp4/methodParameters.mustache

@@ -1 +1 @@
-{{#authMethods.0}}{{#authMethods}}{{#isApiKey}}{{#isKeyInHeader}}apiKeyHeader: String{{/isKeyInHeader}}{{#isKeyInQuery}}apiKeyQuery: String{{/isKeyInQuery}}{{#isKeyInCookie}}apiKeyCookie: String{{/isKeyInCookie}}{{/isApiKey}}{{#isBasic}}{{#isBasicBasic}}username: String, password: String{{/isBasicBasic}}{{#isBasicBearer}}bearerToken: String{{/isBasicBearer}}{{/isBasic}}{{^-last}}, {{/-last}}{{/authMethods}})({{/authMethods.0}}{{#allParams}}{{paramName}}: {{#required}}{{dataType}}{{/required}}{{^required}}{{#isContainer}}{{dataType}}{{/isContainer}}{{^isContainer}}Option[{{dataType}}]{{/isContainer}}{{/required}}{{^defaultValue}}{{^required}}{{^isContainer}} = None{{/isContainer}}{{/required}}{{/defaultValue}}{{^-last}}, {{/-last}}{{/allParams}}
+{{#authMethods.0}}{{#authMethods}}{{#isApiKey}}{{#isKeyInHeader}}apiKeyHeader: String{{/isKeyInHeader}}{{#isKeyInQuery}}apiKeyQuery: String{{/isKeyInQuery}}{{#isKeyInCookie}}apiKeyCookie: String{{/isKeyInCookie}}{{/isApiKey}}{{#isBasic}}{{#isBasicBasic}}username: String, password: String{{/isBasicBasic}}{{#isBasicBearer}}bearerToken: String{{/isBasicBearer}}{{/isBasic}}{{^-last}}, {{/-last}}{{/authMethods}})({{/authMethods.0}}{{#allParams}}{{paramName}}: {{#required}}{{dataType}}{{/required}}{{^required}}Option[{{dataType}}]{{/required}}{{#defaultValue}} = {{{defaultValue}}}{{/defaultValue}}{{^-last}}, {{/-last}}{{/allParams}}