API Module: About - mschnitzer/open-build-service-api GitHub Wiki

The About module is a wrapper for the Build Service its /about endpoint.

Introduction

The about route returns basic information about the running build service, such as: name of the Build Service, description of the Build Service, revision which is in use (like the version number of the Build Service), last deployment date, and the git commit hash which is being installed.

How to Use

The about module can be accessed via an OpenBuildServiceAPI::Connection object and its about method:

api = OpenBuildServiceAPI::Connection.new(username, password)
puts api.about

Instance Variable: title

Returns the title of the Build Service.

Return value: String

Example:

puts api.about.title

Instance Variable: description

Returns the description of the Build Service.

Return value: String

Example:

puts api.about.description

Instance Variable: revision

Returns the revision (also known as the deployed version) of the Build Service.

Return value: String

Example:

puts api.about.revision

Instance Variable: last_deployment

Returns the name of the Build Service.

Return value: DateTime or nil

Example:

puts api.about.last_deployment

Instance Variable: commit

Returns the git commit hash which is in use.

Return value: String

Example:

puts api.about.commit

Instance Method: reload!

Querys the information from the Build Service again and refreshes it.

Return value: boolean (true)

Example:

api.about.reload!