Class: Yori::Schema::V3::Response

Inherits:
Yori::SchemaBase show all
Defined in:
lib/yori/schema/v3/response.rb

Overview

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

Instance Attribute Summary

Attributes inherited from Yori::SchemaBase

#id

Instance Method Summary collapse

Methods inherited from Yori::SchemaBase

eval_class!, eval_hash!, eval_input!, #ref, #validator

Instance Method Details

#content ⇒ Object

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



22
 
# File 'lib/yori/schema/v3/response.rb', line 22

hash_field_block :content, :content_type, Yori::Schema::V3::MediaType

#description ⇒ Object

REQUIRED. A short description of the response. CommonMark syntax MAY be used for rich text representation.



14
 
# File 'lib/yori/schema/v3/response.rb', line 14

fields :description

#headers ⇒ Object

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.



18
 
# File 'lib/yori/schema/v3/response.rb', line 18

hash_field_block :headers, :header, Yori::Schema::V3::Header

#links ⇒ Object

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.



26
 
# File 'lib/yori/schema/v3/response.rb', line 26

hash_field_block :links, :link, Yori::Schema::V3::Link

#validate! ⇒ Object 



28
29
30
 
# File 'lib/yori/schema/v3/response.rb', line 28

def validate!
  validate_require_fields!('description')
end