Module: Octokit::Client::ServiceStatus

Included in:
Octokit::Client
Defined in:
lib/octokit/client/service_status.rb

Overview

Methods for the GitHub Status API

Constant Summary collapse

STATUS_ROOT =

Root for status API

'https://status.github.com/api.json'

Instance Method Summary collapse

Instance Method Details

#github_statusSawyer::Resource

Returns the current system status

Returns:

  • (Sawyer::Resource)

    GitHub status

See Also:



17
18
19
# File 'lib/octokit/client/service_status.rb', line 17

def github_status
  get(STATUS_ROOT).rels[:status].get.data
end

#github_status_last_messageSawyer::Resource

Returns the last human communication, status, and timestamp.

Returns:

  • (Sawyer::Resource)

    GitHub status last message

See Also:



25
26
27
# File 'lib/octokit/client/service_status.rb', line 25

def github_status_last_message
  get(STATUS_ROOT).rels[:last_message].get.data
end

#github_status_messagesArray<Sawyer::Resource>

Returns the most recent human communications with status and timestamp.

Returns:

  • (Array<Sawyer::Resource>)

    GitHub status messages

See Also:



33
34
35
# File 'lib/octokit/client/service_status.rb', line 33

def github_status_messages
  get(STATUS_ROOT).rels[:messages].get.data
end