Info

GitHub

Wraps API metadata/info.

Example

info = api.info
info.title # => "My API"
info.version # => "1.0.0"
info.description # => "API for managing resources"
info.contact&.email # => "support@example.com"
info.license&.name # => "MIT"

Modules

• Contact
• License
• Server

Instance Methods

#contact

#contact

GitHub

The API contact.

Returns

Info::Contact, nil

See also

• Info::Contact

---

#description

#description

GitHub

The API description.

Returns

String, nil

---

#license

#license

GitHub

The API license.

Returns

Info::License, nil

See also

• Info::License

---

#servers

#servers

GitHub

The API servers.

Returns

Array<Info::Server>

See also

• Info::Server

---

#summary

#summary

GitHub

The API summary.

Returns

String, nil

---

#terms_of_service

#terms_of_service

GitHub

The API terms of service.

Returns

String, nil

---

#title

#title

GitHub

The API title.

Returns

String, nil

---

#to_h

#to_h

GitHub

Converts the API info to a hash.

Returns

Hash

---

#version

#version

GitHub

The API version.

Returns

String, nil

---