Server

GitHub

Server definition block.

Used within the server block in API::Info.

Instance Methods

#description

#description(value = nil)

GitHub

The server description.

Parameters

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

Returns

String, nil

Example

description 'Production'
server.description # => "Production"

---

#url

#url(value = nil)

GitHub

The server URL.

Parameters

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

Returns

String, nil

Example

url 'https://api.example.com'
server.url # => "https://api.example.com"

---