Skip to content

issue where schema annotations can be ignored (after recent changes) #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 6, 2022
Merged

issue where schema annotations can be ignored (after recent changes) #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f304d9f
issue where schema annotations can be ignored (after recent changes)
pjfanning Aug 6, 2022
6ecb81a
Update SwaggerScalaModelConverter.scala
pjfanning Aug 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions src/main/scala/com/github/swagger/scala/converter/SwaggerScalaModelConverter.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ class SwaggerScalaModelConverter extends ModelResolver(SwaggerScalaModelConverte
SwaggerScalaModelConverter

private val logger = LoggerFactory.getLogger(classOf[SwaggerScalaModelConverter])
private val VoidClass = classOf[Void]
private val EnumClass = classOf[scala.Enumeration]
private val OptionClass = classOf[scala.Option[_]]
private val IterableClass = classOf[scala.collection.Iterable[_]]
Expand Down Expand Up @@ -79,20 +80,24 @@ class SwaggerScalaModelConverter extends ModelResolver(SwaggerScalaModelConverte
val introspector = BeanIntrospector(cls)
val erasedProperties = ErasureHelper.erasedOptionalPrimitives(cls)
introspector.properties.foreach { property =>

val propertyClass = getPropertyClass(property)
val isOptional = isOption(propertyClass)

erasedProperties.get(property.name).foreach { erasedType =>
val primitiveType = PrimitiveType.fromType(erasedType)
if (primitiveType != null && isOptional) {
updateTypeOnSchema(schema, primitiveType, property.name)
}
if (primitiveType != null && isIterable(propertyClass) && !isMap(propertyClass)) {
updateTypeOnItemsSchema(schema, primitiveType, property.name)
val propertyAnnotations = getPropertyAnnotations(property)
val schemaOverrideClass = propertyAnnotations.collectFirst {
case s: SchemaAnnotation if s.implementation() != VoidClass => s.implementation()
}
if (schemaOverrideClass.isEmpty) {
erasedProperties.get(property.name).foreach { erasedType =>
val primitiveType = PrimitiveType.fromType(erasedType)
if (primitiveType != null && isOptional) {
updateTypeOnSchema(schema, primitiveType, property.name)
}
if (primitiveType != null && isIterable(propertyClass) && !isMap(propertyClass)) {
updateTypeOnItemsSchema(schema, primitiveType, property.name)
}
}
}
getPropertyAnnotations(property) match {
propertyAnnotations match {
case Seq() => {
if (isOptional && schema.getRequired != null && schema.getRequired.contains(property.name)) {
schema.getRequired.remove(property.name)
Expand Down
13 changes: 13 additions & 0 deletions src/test/scala/com/github/swagger/scala/converter/ModelPropertyParserTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,19 @@ class ModelPropertyParserTest extends AnyFlatSpec with Matchers with OptionValue
nullSafeList(model.value.getRequired) shouldBe empty
}

it should "process Model with Scala Option Long with Schema Int Override" in {
val converter = ModelConverters.getInstance()
val schemas = converter.readAll(classOf[ModelWOptionLongSchemaIntOverride]).asScala.toMap
val model = schemas.get("ModelWOptionLongSchemaIntOverride")
model should be(defined)
model.value.getProperties should not be (null)
val optLong = model.value.getProperties().get("optLong")
optLong should not be (null)
optLong shouldBe a[IntegerSchema]
optLong.asInstanceOf[IntegerSchema].getFormat shouldEqual "int32"
nullSafeList(model.value.getRequired) shouldBe empty
}

it should "process Model with Scala Option Boolean" in {
val converter = ModelConverters.getInstance()
val schemas = converter.readAll(classOf[ModelWOptionBoolean]).asScala.toMap
Expand Down
2 changes: 2 additions & 0 deletions src/test/scala/models/ModelWOptionLong.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@ import io.swagger.v3.oas.annotations.media.Schema
case class ModelWOptionLong(optLong: Option[Long])

case class ModelWOptionLongSchemaOverride(@Schema(implementation = classOf[Long]) optLong: Option[Long])

case class ModelWOptionLongSchemaIntOverride(@Schema(implementation = classOf[Int]) optLong: Option[Long])