Module: Buildkit::Client::Projects

Included in:

Buildkit::Client

Defined in:

lib/buildkit/client/projects.rb

Overview

Methods for the Projects API

See Also:

• https://buildkite.com/docs/api/projects

Instance Method Summary

• #project(org, project, options = {}) ⇒ Sawyer::Resource

  Get a project.

• #projects(org, options = {}) ⇒ Array<Sawyer::Resource>

  List projects.

Instance Method Details

#project(org, project, options = {}) ⇒ Sawyer::Resource

Get a project

Examples:

Buildkit.project('my-great-org', 'great-project')

Parameters:

• org (String) —

  Organization slug.

• project (String) —

  Project slug.

Returns:

• (Sawyer::Resource) —

  Hash representing Buildkite project

See Also:

• https://buildkite.com/docs/api/projects#get-a-project

# File 'lib/buildkit/client/projects.rb', line 25

def project(org, project, options = {})
  get("/v1/organizations/#{org}/projects/#{project}", options)
end

#projects(org, options = {}) ⇒ Array<Sawyer::Resource>

List projects

Examples:

Buildkit.projects('my-great-org')

Returns:

• (Array<Sawyer::Resource>) —

  Array of hashes representing Buildkite projects.

See Also:

• https://buildkite.com/docs/api/projects#list-projects

# File 'lib/buildkit/client/projects.rb', line 13

def projects(org, options = {})
  get("/v1/organizations/#{org}/projects", options)
end