RequestBody

zio.blocks.openapi.RequestBody

See theRequestBody companion object

final case class RequestBody(content: ChunkMap[String, MediaType], description: Option[Doc] = ..., required: Boolean = ..., extensions: ChunkMap[String, Json] = ...)

Describes a single request body.

Value parameters

content: REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/wildcard
description: A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
extensions: Specification extensions (x-* fields). These allow adding additional properties beyond the standard OpenAPI fields.
required: Determines if the request body is required in the request. Defaults to false.

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