Attributes
- Companion
- class
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
Members list
Value members
Concrete methods
Attributes
- Returns
-
collection flags based on any Swagger annotations for this type
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.
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.
Attributes
- Returns
-
value value: true by default
- Since
-
v2.7.4
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.
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.
Attributes
- Returns
-
value: true by default
- Since
-
v2.7.6
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.
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 parameters
- value
-
true by default
Attributes
- Since
-
v2.7.4
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.
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 parameters
- value
-
true by default
Attributes
- Since
-
v2.7.6