Response

final case class Response(description: Doc, headers: Map[String, HeaderOrReference], content: Map[String, MediaType], links: Map[String, LinkOrReference]) extends ResponseOrReference

Describes a single response from an API Operation, including design-time, static links to operations based on the response.

Value parameters:
content

A map containing descriptions of potential response payloads. The key is a media type or [media type range]appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable.

description

A short description of the response.

headers

Maps a header name to its definition. [RFC7230] states header names are case insensitive. If a response header is defined with the name "Content-Type", it SHALL be ignored.

links

A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects.

trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

override def toJson: String
Definition Classes
OpenAPIBase

Inherited methods

Inherited from:
Product