Info

GitHub

Block context for defining API metadata.

Used within the info block in API::Base.

Modules

• Contact
• License
• Server

Instance Methods

#contact

#contact(&block)

GitHub

The API contact.

Returns

Contact, nil

Yields Contact

Example: instance_eval style

contact do
  name 'Support'
  email 'support@example.com'
end

Example: yield style

contact do |contact|
  contact.name 'Support'
  contact.email 'support@example.com'
end

---

#deprecated!

#deprecated!

GitHub

Marks the API as deprecated.

Returns

void

Example

info do
  deprecated!
end

---

#deprecated?

#deprecated?

GitHub

Whether the API is deprecated.

Returns

Boolean

---

#description

#description(value = nil)

GitHub

The API description.

Parameters

Name	Type	Default	Description
value	String, nil	nil	The description.

Returns

String, nil

Example

description 'Full-featured API for managing invoices and payments.'
info.description # => "Full-featured..."

---

#license

#license(&block)

GitHub

The API license.

Returns

License, nil

Yields License

Example: instance_eval style

license do
  name 'MIT'
  url 'https://opensource.org/licenses/MIT'
end

Example: yield style

license do |license|
  license.name 'MIT'
  license.url 'https://opensource.org/licenses/MIT'
end

---

#server

#server(&block)

GitHub

Defines a server for the API.

Can be called multiple times.

Returns

Array<Server>

Yields Server

Example: instance_eval style

server do
  url 'https://api.example.com'
  description 'Production'
end

Example: yield style

server do |server|
  server.url 'https://api.example.com'
  server.description 'Production'
end

---

#summary

#summary(value = nil)

GitHub

The API summary.

Parameters

Name	Type	Default	Description
value	String, nil	nil	The summary.

Returns

String, nil

Example

summary 'Invoice management API'
info.summary # => "Invoice management API"

---

#tags

#tags(*values)

GitHub

The API tags.

Parameters

Name	Type	Default	Description
values	Array<String>		The tags.

Returns

Array<String>

Example

tags 'invoices', 'payments'
info.tags # => ["invoices", "payments"]

---

#terms_of_service

#terms_of_service(value = nil)

GitHub

The API terms of service.

Parameters

Name	Type	Default	Description
value	String, nil	nil	The URL to terms of service.

Returns

String, nil

Example

terms_of_service 'https://example.com/terms'
info.terms_of_service # => "https://example.com/terms"

---

#title

#title(value = nil)

GitHub

The API title.

Parameters

Name	Type	Default	Description
value	String, nil	nil	The title.

Returns

String, nil

Example

title 'Invoice API'
info.title # => "Invoice API"

---

#version

#version(value = nil)

GitHub

The API version.

Parameters

Name	Type	Default	Description
value	String, nil	nil	The version.

Returns

String, nil

Example

version '1.0.0'
info.version # => "1.0.0"

---