class

Open::Api::RequestBody

Inherits YAML::Serializable < JSON::Serializable < Reference < Object

Constructors

new(description : Nil | String, content : Hash(String, Open::Api::MediaType), required : Bool)
Source
new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
Source
new(description : Nil | String, content : Hash(String, Open::Api::MediaType))
Source
new(pull : JSON::PullParser)
Source
new(description : Nil | String, content : Hash(String, Open::Api::MediaType) = Hash(String, Open::Api::MediaType).new, required : Bool = false)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node)
Source

Instance methods

content

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/*

Source
content=(content : Hash(String, Open::Api::MediaType))

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/*

Source
description

A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.

Source
description=(description : String | Nil)

A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.

Source
required

Determines if the request body is required in the request. Defaults to false.

Source
required=(required : Bool)

Determines if the request body is required in the request. Defaults to false.

Source