Class: Jsapi::Meta::Response::Reference

Inherits:

Model::Reference

• Object
• Model::Base
• Model::Reference
• Jsapi::Meta::Response::Reference

Defined in:

lib/jsapi/meta/response/reference.rb

Overview

Refers a reusable response.

Instance Method Summary

• #locale ⇒ Object

  :attr: locale Overrides the locale of the referred response.

• #nodoc ⇒ Object

  :attr: nodoc Prevents the reference to be described in generated OpenAPI documents.

Methods inherited from Model::Reference

component_type, #description, openapi_component_type, #ref, #reference?, #resolve, #resolve_lazily, #summary, #to_openapi

Methods inherited from Model::Base

#initialize, #inspect, #merge!, #reference?, #resolve

Methods included from Model::Attributes

#attributes_frozen?, #freeze_attributes, included

Constructor Details

This class inherits a constructor from Jsapi::Meta::Model::Base

Instance Method Details

#locale ⇒ Object

:attr: locale Overrides the locale of the referred response.

# File 'lib/jsapi/meta/response/reference.rb', line 11

attribute :locale, Symbol

#nodoc ⇒ Object

:attr: nodoc Prevents the reference to be described in generated OpenAPI documents.

# File 'lib/jsapi/meta/response/reference.rb', line 16

attribute :nodoc, values: [true, false]