com.github.swagger.scala.converter
SwaggerScalaModelConverter
Companion class SwaggerScalaModelConverter
object SwaggerScalaModelConverter
- Alphabetic
- By Inheritance
- SwaggerScalaModelConverter
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getRequiredSettings(annotatedType: AnnotatedType): Seq[Boolean]
- returns
collection flags based on any Swagger annotations for this type
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isRequiredBasedOnAnnotation: Boolean
If you use swagger annotations to override what is automatically derived, then be aware that io.swagger.v3.oas.annotations.media.Schema annotation has required = false, by default.
If you use swagger annotations to override what is automatically derived, then be aware that io.swagger.v3.oas.annotations.media.Schema annotation has required = false, by default. You are advised to set the required flag on this annotation to the correct value. If you would prefer to have the Schema annotation required flag ignored and to rely on the this module inferring the value (as it would if you don't annotate the classes or fields), then set SwaggerScalaModelConverter.setRequiredBasedOnAnnotation to true and the required property on the annotation will be ignored, unless the field is an Option.
- returns
value value: true by default
- Since
v2.7.4
-
def
isRequiredBasedOnDefaultValue: Boolean
If you use swagger annotations to override what is automatically derived, then this flag will not be used.
If you use swagger annotations to override what is automatically derived, then this flag will not be used. If you rely on this module inferring the required flag (as it would if you don't annotate the classes or fields), then this flag will control how the required flag is derived when a default value exists. If SwaggerScalaModelConverter.setRequiredBasedOnDefaultValue is true and a property has a default value, then it will not be required. However, if this flag is false, then a property will be required only if it's not an Option.
- returns
value: true by default
- Since
v2.7.6
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
setRequiredBasedOnAnnotation(value: Boolean = true): Unit
If you use swagger annotations to override what is automatically derived, then be aware that io.swagger.v3.oas.annotations.media.Schema annotation has required = false, by default.
If you use swagger annotations to override what is automatically derived, then be aware that io.swagger.v3.oas.annotations.media.Schema annotation has required = false, by default. You are advised to set the required flag on this annotation to the correct value. If you would prefer to have the Schema annotation required flag ignored and to rely on the this module inferring the value (as it would if you don't annotate the classes or fields), then set SwaggerScalaModelConverter.setRequiredBasedOnAnnotation to true and the required property on the annotation will be ignored, unless the field is an Option.
- value
true by default
- Since
v2.7.4
-
def
setRequiredBasedOnDefaultValue(value: Boolean = true): Unit
If you use swagger annotations to override what is automatically derived, then this flag will not be used.
If you use swagger annotations to override what is automatically derived, then this flag will not be used. If you rely on this module inferring the required flag (as it would if you don't annotate the classes or fields), then this flag will control how the required flag is derived when a default value exists. If SwaggerScalaModelConverter.setRequiredBasedOnDefaultValue is true and a property has a default value, then it will not be required. However, if this flag is false, then a property will be required only if it's not an Option.
- value
true by default
- Since
v2.7.6
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()