### Home Classes Methods

### In Files

- lib/github_api/issues/milestones.rb

### Parent

Github::API

### Methods

- #all
- #create
- #delete
- #find
- #get
- #list
- #update

### Class/Module Index

Quicksearch

- Github
- Github::API
- Github::Activity
- Github::Activity::Events
- Github::Activity::Notifications
- Github::Activity::Starring
- Github::Activity::Watching
- Github::ApiFactory
- Github::Arguments
- Github::Authorization
- Github::Authorizations
- Github::AutoloadHelper
- Github::Client
- Github::Configuration
- Github::Connection
- Github::Constants
- Github::CoreExt
- Github::CoreExt::OrderedHash
- Github::Descendants
- Github::Emojis
- Github::Error
- Github::Error::BadRequest
- Github::Error::ClientError
- Github::Error::Forbidden
- Github::Error::GithubError
- Github::Error::InternalServerError
- Github::Error::InvalidOptions
- Github::Error::NotAcceptable
- Github::Error::NotFound
- Github::Error::RequiredParams
- Github::Error::ServiceError
- Github::Error::ServiceUnavailable
- Github::Error::Unauthorized
- Github::Error::UnknownValue
- Github::Error::UnprocessableEntity
- Github::Error::Validations
- Github::Gists
- Github::Gists::Comments
- Github::GitData
- Github::GitData::Blobs
- Github::GitData::Commits
- Github::GitData::References
- Github::GitData::Tags
- Github::GitData::Trees
- Github::Gitignore
- Github::Issues
- Github::Issues::Assignees
- Github::Issues::Comments
- Github::Issues::Events
- Github::Issues::Labels
- Github::Issues::Milestones
- Github::Jsonable
- Github::Markdown
- Github::Meta
- Github::MimeType
- Github::Normalizer
- Github::Orgs
- Github::Orgs::Members
- Github::Orgs::Teams
- Github::PageIterator
- Github::PageLinks
- Github::PagedRequest
- Github::Pagination
- Github::ParameterFilter
- Github::ParamsHash
- Github::PullRequests
- Github::PullRequests::Comments
- Github::RateLimit
- Github::Repos
- Github::Repos::Collaborators
- Github::Repos::Comments
- Github::Repos::Commits
- Github::Repos::Contents
- Github::Repos::Downloads
- Github::Repos::Forks
- Github::Repos::Hooks
- Github::Repos::Keys
- Github::Repos::Merging
- Github::Repos::PubSubHubbub
- Github::Repos::Statistics
- Github::Repos::Statuses
- Github::Request
- Github::Request::BasicAuth
- Github::Request::Jsonize
- Github::Request::OAuth2
- Github::Resource
- Github::Response
- Github::Response::Header
- Github::Response::Jsonize
- Github::Response::Mashify
- Github::Response::RaiseError
- Github::Response::Xmlize
- Github::ResponseWrapper
- Github::S3Uploader
- Github::Say
- Github::Scopes
- Github::Search
- Github::Users
- Github::Users::Emails
- Github::Users::Followers
- Github::Users::Keys
- Github::Utils
- Github::Utils::Url
- Github::VERSION
- Github::Validations
- Github::Validations::Format
- Github::Validations::Presence
- Github::Validations::Required
- Github::Validations::Token
- Hash

No matching classes.

# Github::Issues::Milestones

### Constants

VALID_MILESTONE_INPUTS

### Public Instance Methods

all(*args) click to toggle source
Alias for: list
create(*args) click to toggle source

Create a milestone

# Inputs

    <tt>:title</tt> - Required string
    <tt>:state</tt> - Optional string - <tt>open</tt> or <tt>closed</tt>
    <tt>:description</tt> - Optional string
    <tt>:due_on</tt> - Optional string - ISO 8601 time

# Examples

    github = Github.new :user => 'user-name', :repo => 'repo-name'
    github.issues.milestones.create :title => 'hello-world',
      :state => "open or closed",
      :description => "String",
      :due_on => "Time"

    # File lib/github_api/issues/milestones.rb, line 76
    def create(*args)
      arguments(args, :required => [:user, :repo]) do
        sift VALID_MILESTONE_INPUTS
        assert_required ] title ]
      end

      post_request("/repos/#{user}/#{repo}/milestones", arguments.params)
    end

delete(*args) click to toggle source

Delete a milestone

# Examples

    github = Github.new
    github.issues.milestones.delete 'user-name', 'repo-name', 'milestone-id'

    # File lib/github_api/issues/milestones.rb, line 116
    def delete(*args)
      arguments(args, :required => [:user, :repo, :milestone_id])
      params = arguments.params

      delete_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
    end

find(*args) click to toggle source
Alias for: get
get(*args) click to toggle source

Get a single milestone

# Examples

    github = Github.new
    github.issues.milestones.get 'user-name', 'repo-name', 'milestone-id'

    # File lib/github_api/issues/milestones.rb, line 53
    def get(*args)
      arguments(args, :required => [:user, :repo, :milestone_id])
      params = arguments.params

      get_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
    end

Also aliased as: find
list(*args) click to toggle source

List milestones for a repository

# Parameters

`:state` - `open`, `closed`, default: `open` `:sort` - `due_date`, `completeness`, default: `due_date` `:direction` - `asc`, `desc`, default: `desc`

# Examples

    github = Github.new user: 'user-name', repo: 'repo-name'
    github.issues.milestones.list

    or

    github.issues.milestones.list state: 'open', sort: 'due_date',
      direction: 'asc'

    # File lib/github_api/issues/milestones.rb, line 34
    def list(*args)
      arguments(args, :required => [:user, :repo]) do
        sift VALID_MILESTONE_OPTIONS.keys
        assert_values VALID_MILESTONE_OPTIONS
      end
      params = arguments.params

      response = get_request("/repos/#{user}/#{repo}/milestones", params)
      return response unless block_given?
      response.each { |el| yield el }
    end

Also aliased as: all
update(*args) click to toggle source

Update a milestone

# Inputs

    <tt>:title</tt> - Required string
    <tt>:state</tt> - Optional string - <tt>open</tt> or <tt>closed</tt>
    <tt>:description</tt> - Optional string
    <tt>:due_on</tt> - Optional string - ISO 8601 time

# Examples

    github = Github.new
    github.issues.milestones.update 'user-name', 'repo-name', 'milestone-id',
      :title => 'hello-world',
      :state => "open or closed",
      :description => "String",
      :due_on => "Time"

    # File lib/github_api/issues/milestones.rb, line 101
    def update(*args)
      arguments(args, :required => [:user, :repo, :milestone_id]) do
        sift VALID_MILESTONE_INPUTS
      end
      params = arguments.params

      patch_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.