Class: Jsapi::Meta::ExternalDocumentation

Inherits:

Base::Model

• Object
• Base::Model
• Jsapi::Meta::ExternalDocumentation

Includes:

OpenAPI::Extensions

Defined in:

lib/jsapi/meta/external_documentation.rb

Overview

Specifies an external documentation object.

Constant Summary

Constants included from Base::Attributes

Base::Attributes::DEFAULT_ARRAY, Base::Attributes::DEFAULT_HASH

Instance Method Summary

• #description ⇒ Object

  :attr: description The description of the external documentation.

• #to_openapi ⇒ Object

  Returns a hash representing the OpenAPI external documentation object.

• #url ⇒ Object

  :attr: url The URL of the external documentation.

Methods included from OpenAPI::Extensions

#add_openapi_extension, #openapi_extensions, #openapi_extensions=

Methods inherited from Base::Model

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

Methods included from Base::Attributes

#attribute, #attribute_names

Constructor Details

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

Instance Method Details

#description ⇒ Object

:attr: description The description of the external documentation.

# File 'lib/jsapi/meta/external_documentation.rb', line 12

attribute :description, String

#to_openapi ⇒ Object

Returns a hash representing the OpenAPI external documentation object.

# File 'lib/jsapi/meta/external_documentation.rb', line 20

def to_openapi(*)
  with_openapi_extensions(url: url, description: description)
end

#url ⇒ Object

:attr: url The URL of the external documentation.

# File 'lib/jsapi/meta/external_documentation.rb', line 17

attribute :url, String