Class: Jsapi::Meta::Tag

Inherits:
Base::Model show all
Includes:
OpenAPI::Extensions
Defined in:
lib/jsapi/meta/tag.rb

Overview

Specifies a tag object.

Constant Summary

Constants included from Base::Attributes

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

Instance Method Summary collapse

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 tag.



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

attribute :description, String

#external_docs ⇒ Object

:attr: external_docs The ExternalDocumentation object.



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

attribute :external_docs, ExternalDocumentation

#name ⇒ Object

:attr: name The name of the tag.



22
 
# File 'lib/jsapi/meta/tag.rb', line 22

attribute :name, String

#to_openapi ⇒ Object

Returns a hash representing the OpenAPI tag object.



25
26
27
28
29
30
31
 
# File 'lib/jsapi/meta/tag.rb', line 25

def to_openapi(*)
  with_openapi_extensions(
    name: name,
    description: description,
    externalDocs: external_docs&.to_openapi
  )
end