Class: Spikard::ContactInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/spikard/config.rb

Overview

Contact information for OpenAPI documentation.

Examples:

contact = ContactInfo.new(
  name: 'API Team',
  email: 'api@example.com',
  url: 'https://example.com'
)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name: nil, email: nil, url: nil) ⇒ ContactInfo

Returns a new instance of ContactInfo.

Parameters:

  • name (String, nil) (defaults to: nil) —

    Name of the contact person/organization

  • email (String, nil) (defaults to: nil) —

    Email address for contact

  • url (String, nil) (defaults to: nil) —

    URL for contact information



151
152
153
154
155
 
# File 'lib/spikard/config.rb', line 151

def initialize(name: nil, email: nil, url: nil)
  @name = name
  @email = email
  @url = url
end

Instance Attribute Details

#email ⇒ Object

Returns the value of attribute email.



146
147
148
 
# File 'lib/spikard/config.rb', line 146

def email
  @email
end

#name ⇒ Object

Returns the value of attribute name.



146
147
148
 
# File 'lib/spikard/config.rb', line 146

def name
  @name
end

#url ⇒ Object

Returns the value of attribute url.



146
147
148
 
# File 'lib/spikard/config.rb', line 146

def url
  @url
end