Skip to content

check ArraySchema annotation #312

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 4 commits into from
Feb 2, 2024
Merged

check ArraySchema annotation #312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1c417b2
check ArraySchema annotation
pjfanning Feb 2, 2024
235b2b6
scala 2.12 compile issue
pjfanning Feb 2, 2024
f17cb15
Update SwaggerScalaModelConverter.scala
pjfanning Feb 2, 2024
9ae8830
Update ModelPropertyParserTest.scala
pjfanning Feb 2, 2024
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
18 changes: 17 additions & 1 deletion 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 @@ -5,6 +5,7 @@ import com.fasterxml.jackson.databind.{JavaType, ObjectMapper}
import com.fasterxml.jackson.module.scala.introspect.{BeanIntrospector, PropertyDescriptor}
import com.fasterxml.jackson.module.scala.util.ClassW
import com.fasterxml.jackson.module.scala.{DefaultScalaModule, JsonScalaEnumeration}
import com.github.swagger.scala.converter.SwaggerScalaModelConverter.nullSafeSeq
import io.swagger.v3.core.converter._
import io.swagger.v3.core.jackson.ModelResolver
import io.swagger.v3.core.util.{Json, PrimitiveType}
Expand Down Expand Up @@ -233,6 +234,20 @@ class SwaggerScalaModelConverter extends ModelResolver(SwaggerScalaModelConverte
val classOption: Option[Class[_]] = if (s.implementation() == VoidClass) None else Option(s.implementation())
classOption
}
val arraySchemaOverrideClass = if (schemaOverride.nonEmpty) {
None
} else {
val arraySchemaOverride = propertyAnnotations.collectFirst { case as: ArraySchemaAnnotation => as }
arraySchemaOverride.flatMap { as =>
val itemSchema = if (as.items() == null || as.items().implementation() == VoidClass) as.schema() else as.items()
val classOption: Option[Class[_]] = if (itemSchema == null || itemSchema.implementation() == VoidClass) {
None
} else {
Option(itemSchema.implementation())
}
classOption
}
}
val maybeDefault = property.param.flatMap(_.defaultValue)
val schemaDefaultValue = schemaOverride.flatMap { s =>
Option(s.defaultValue()).flatMap(str => if (str.isEmpty) None else Some(str))
Expand Down Expand Up @@ -260,7 +275,8 @@ class SwaggerScalaModelConverter extends ModelResolver(SwaggerScalaModelConverte
}
}

if (schemaProperties.nonEmpty && schemaOverrideClass.isEmpty) {
val overrideClass = schemaOverrideClass.orElse(arraySchemaOverrideClass)
if (schemaProperties.nonEmpty && overrideClass.isEmpty) {
erasedProperties.get(propertyName).foreach { erasedType =>
schemaProperties.get(propertyName).foreach { property =>
Option(PrimitiveType.fromType(erasedType)).foreach { primitiveType =>
Expand Down
5 changes: 2 additions & 3 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,7 +182,7 @@ class ModelPropertyParserTest extends AnyFlatSpec with BeforeAndAfterEach with M
val arraySchema = numbers.asInstanceOf[ArraySchema]
arraySchema.getMinItems shouldEqual 2
arraySchema.getMaxItems shouldEqual 10
// TODO - this should be an IntegerSchema but the @ArraySchema annotation items schema is not being picked up
// assertion disabled due to https://github.com/swagger-api/swagger-core/issues/4610
// arraySchema.getItems shouldBe an[IntegerSchema]
}

Expand All @@ -193,8 +193,7 @@ class ModelPropertyParserTest extends AnyFlatSpec with BeforeAndAfterEach with M
val arraySchema = numbers.asInstanceOf[ArraySchema]
arraySchema.getMinItems shouldEqual 2
arraySchema.getMaxItems shouldEqual 10
// TODO - this should be an IntegerSchema but the @ArraySchema annotation items schema is not being picked up
// arraySchema.getItems shouldBe an[IntegerSchema]
arraySchema.getItems shouldBe an[IntegerSchema]
}

it should "process Model without any properties" in new TestScope {
Expand Down