Response

zio.blocks.openapi.Response

See theResponse companion object

final case class Response(description: Doc, headers: ChunkMap[String, ReferenceOr[Header]] = ..., content: ChunkMap[String, MediaType] = ..., links: ChunkMap[String, ReferenceOr[Link]] = ..., extensions: ChunkMap[String, Json] = ...)

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 and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/wildcard
description: REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation.
extensions: Specification extensions (x-* fields). These allow adding additional properties beyond the standard OpenAPI fields.
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.

Companion: object
Source: OpenAPI.scala
Graph
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

An iterator over the names of all the elements of this product.

An iterator over all the elements of this product.

In this article