class Github::Client::Projects

Projects API

Public Instance Methods

delete(*args) click to toggle source

Delete a project

@example

github = Github.new
github.projects.delete 1002604

@api public

# File lib/github_api/client/projects.rb, line 73
def delete(*args)
  arguments(args, required: [:id])
  params = arguments.params

  params["accept"] ||= PREVIEW_MEDIA

  delete_request("/projects/#{arguments.id}", arguments.params)
end
Also aliased as: remove
edit(*args) click to toggle source

Edit a project

@param [Hash] params @option params [String] :name

Optional string

@option params [String] :body

Optional string

@option params [String] :state

Optional string

@example

github = Github.new
github.projects.edit 1002604,
  name: "Outcomes Tracker",
  body: "The board to track work for the Outcomes application."

@api public

# File lib/github_api/client/projects.rb, line 57
def edit(*args)
  arguments(args, required: [:id])
  params = arguments.params

  params["accept"] ||= PREVIEW_MEDIA

  patch_request("/projects/#{arguments.id}", params)
end
find(*args)
Alias for: get
get(*args) click to toggle source

Get properties for a single project

@see developer.github.com/v3/projects/#get-a-project

@example

github = Github.new
github.projects.get 1002604

@api public

# File lib/github_api/client/projects.rb, line 30
def get(*args)
  arguments(args, required: [:id])
  params = arguments.params

  params["accept"] ||= PREVIEW_MEDIA

  get_request("/projects/#{arguments.id}", params)
end
Also aliased as: find
remove(*args)
Alias for: delete