Class

endpoints.openapi.Responses

DocumentedResponse

Related Doc: package Responses

Permalink

case class DocumentedResponse(status: Int, documentation: String, content: Map[String, MediaType]) extends Product with Serializable

status: Response status code (e.g. 200)
documentation: Human readable documentation. Not optional because its required by openapi
content: Map that associates each possible content-type (e.g. “text/html”) with a MediaType description

Source: Responses.scala

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

DocumentedResponse
Serializable
Serializable
Product
Equals
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new DocumentedResponse(status: Int, documentation: String, content: Map[String, MediaType])

status
Response status code (e.g. 200)
documentation
Human readable documentation. Not optional because its required by openapi
content
Map that associates each possible content-type (e.g. “text/html”) with a MediaType description

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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val content: Map[String, MediaType]

Map that associates each possible content-type (e.g.
Map that associates each possible content-type (e.g. “text/html”) with a MediaType description
val documentation: String

Human readable documentation.
Human readable documentation. Not optional because its required by openapi
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val status: Int

Response status code (e.g.
Response status code (e.g. 200)
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped