Packages

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.

Linear Supertypes
Serializable, Serializable, Product, Equals, Definition, Schema, SchemaOrReference, OpenAPIBase, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ResponseSchema
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Definition
  7. Schema
  8. SchemaOrReference
  9. OpenAPIBase
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. val deprecated: Boolean
    Definition Classes
    ResponseSchema → Schema
  7. val discriminator: Option[Discriminator]
    Definition Classes
    ResponseSchema → Schema
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. val example: String
    Definition Classes
    ResponseSchema → Schema
  10. val externalDocs: URI
    Definition Classes
    ResponseSchema → Schema
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. val nullable: Boolean
    Definition Classes
    ResponseSchema → Schema
  17. def readOnly: Boolean
    Definition Classes
    ResponseSchema → Schema
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toJson: String
    Definition Classes
    Schema → OpenAPIBase
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. def writeOnly: Boolean
    Definition Classes
    ResponseSchema → Schema
  24. val xml: Option[XML]
    Definition Classes
    ResponseSchema → Schema

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Definition

Inherited from Schema

Inherited from SchemaOrReference

Inherited from OpenAPIBase

Inherited from AnyRef

Inherited from Any

Ungrouped