final case class ResponseSchema(nullable: Boolean = false, discriminator: Option[Discriminator], xml: Option[XML], externalDocs: URI, example: String, deprecated: Boolean = false) extends Schema with Definition with Product with Serializable
The Schema Object allows the definition of input and output data types.
Marked as readOnly. This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is in the required list, the required will take effect on the response only.
- nullable
A true value adds "null" to the allowed type specified by the type keyword, only if type is explicitly defined within the same Schema Object. Other Schema Object constraints retain their defined behavior, and therefore may disallow the use of null as a value. A false value leaves the specified or default type unmodified.
- discriminator
Adds support for polymorphism. The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description.
- xml
This MAY be used only on properties schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property.
- externalDocs
Additional external documentation for this schema.
- example
A free-form property to include an example of an instance for this schema.
- deprecated
Specifies that a schema is deprecated and SHOULD be transitioned out of usage.
- Alphabetic
- By Inheritance
- ResponseSchema
- Serializable
- Product
- Equals
- Definition
- Schema
- SchemaOrReference
- OpenAPIBase
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ResponseSchema(nullable: Boolean = false, discriminator: Option[Discriminator], xml: Option[XML], externalDocs: URI, example: String, deprecated: Boolean = false)
- nullable
A true value adds "null" to the allowed type specified by the type keyword, only if type is explicitly defined within the same Schema Object. Other Schema Object constraints retain their defined behavior, and therefore may disallow the use of null as a value. A false value leaves the specified or default type unmodified.
- discriminator
Adds support for polymorphism. The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description.
- xml
This MAY be used only on properties schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property.
- externalDocs
Additional external documentation for this schema.
- example
A free-form property to include an example of an instance for this schema.
- deprecated
Specifies that a schema is deprecated and SHOULD be transitioned out of usage.
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(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val deprecated: Boolean
- Definition Classes
- ResponseSchema → Schema
- val discriminator: Option[Discriminator]
- Definition Classes
- ResponseSchema → Schema
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val example: String
- Definition Classes
- ResponseSchema → Schema
- val externalDocs: URI
- Definition Classes
- ResponseSchema → Schema
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val nullable: Boolean
- Definition Classes
- ResponseSchema → Schema
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def readOnly: Boolean
- Definition Classes
- ResponseSchema → Schema
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toJson: String
- Definition Classes
- Schema → OpenAPIBase
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def writeOnly: Boolean
- Definition Classes
- ResponseSchema → Schema
- val xml: Option[XML]
- Definition Classes
- ResponseSchema → Schema